Class: AWS.ECS

/* This example creates a cluster in your default region. */

 var params = {
  clusterName: "my_cluster"
 };
 ecs.createCluster(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    cluster: {
     activeServicesCount: 0, 
     clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", 
     clusterName: "my_cluster", 
     pendingTasksCount: 0, 
     registeredContainerInstancesCount: 0, 
     runningTasksCount: 0, 
     status: "ACTIVE"
    }
   }
   */
 });

var params = {
  capacityProviders: [
    'STRING_VALUE',
    /* more items */
  ],
  clusterName: 'STRING_VALUE',
  configuration: {
    executeCommandConfiguration: {
      kmsKeyId: 'STRING_VALUE',
      logConfiguration: {
        cloudWatchEncryptionEnabled: true || false,
        cloudWatchLogGroupName: 'STRING_VALUE',
        s3BucketName: 'STRING_VALUE',
        s3EncryptionEnabled: true || false,
        s3KeyPrefix: 'STRING_VALUE'
      },
      logging: NONE | DEFAULT | OVERRIDE
    },
    managedStorageConfiguration: {
      fargateEphemeralStorageKmsKeyId: 'STRING_VALUE',
      kmsKeyId: 'STRING_VALUE'
    }
  },
  defaultCapacityProviderStrategy: [
    {
      capacityProvider: 'STRING_VALUE', /* required */
      base: 'NUMBER_VALUE',
      weight: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  serviceConnectDefaults: {
    namespace: 'STRING_VALUE' /* required */
  },
  settings: [
    {
      name: containerInsights,
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  tags: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ecs.createCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterName — (String)

    The name of your cluster. If you don't specify a name for your cluster, you create a cluster that's named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

  • tags — (Array<map>)

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

    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.

    • key — (String)

      One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

    • value — (String)

      The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

  • settings — (Array<map>)

    The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

    • name — (String)

      The name of the cluster setting. The value is containerInsights .

      Possible values include:
      • "containerInsights"
    • value — (String)

      The value to set for the cluster setting. The supported values are enabled and disabled.

      If you set name to containerInsights and value to enabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the containerInsights account setting is turned on. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

  • configuration — (map)

    The execute command configuration for the cluster.

    • executeCommandConfiguration — (map)

      The details of the execute command configuration.

      • kmsKeyId — (String)

        Specify an Key Management Service key ID to encrypt the data between the local client and the container.

      • logging — (String)

        The log setting to use for redirecting logs for your execute command results. The following log settings are available.

        • NONE: The execute command session is not logged.

        • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.

        • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

        Possible values include:
        • "NONE"
        • "DEFAULT"
        • "OVERRIDE"
      • logConfiguration — (map)

        The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

        • cloudWatchLogGroupName — (String)

          The name of the CloudWatch log group to send logs to.

          Note: The CloudWatch log group must already be created.
        • cloudWatchEncryptionEnabled — (Boolean)

          Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.

        • s3BucketName — (String)

          The name of the S3 bucket to send logs to.

          Note: The S3 bucket must already be created.
        • s3EncryptionEnabled — (Boolean)

          Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.

        • s3KeyPrefix — (String)

          An optional folder in the S3 bucket to place logs in.

    • managedStorageConfiguration — (map)

      The details of the managed storage configuration.

      • kmsKeyId — (String)

        Specify a Key Management Service key ID to encrypt the managed storage.

      • fargateEphemeralStorageKmsKeyId — (String)

        Specify the Key Management Service key ID for the Fargate ephemeral storage.

  • capacityProviders — (Array<String>)

    The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.

    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

    To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

    The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

  • defaultCapacityProviderStrategy — (Array<map>)

    The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.

    If a default capacity provider strategy isn't defined for a cluster when it was created, it can be defined later with the PutClusterCapacityProviders API operation.

    • capacityProvider — required — (String)

      The short name of the capacity provider.

    • weight — (Integer)

      The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

      If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

      An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

    • base — (Integer)

      The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

  • serviceConnectDefaults — (map)

    Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

    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.

    • namespace — required — (String)

      The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).

      If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.

      If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.

      If you update the cluster with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.

      For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • cluster — (map)

      The full description of your new cluster.

      • clusterArn — (String)

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

      • clusterName — (String)

        A user-generated string that you use to identify your cluster.

      • configuration — (map)

        The execute command configuration for the cluster.

        • executeCommandConfiguration — (map)

          The details of the execute command configuration.

          • kmsKeyId — (String)

            Specify an Key Management Service key ID to encrypt the data between the local client and the container.

          • logging — (String)

            The log setting to use for redirecting logs for your execute command results. The following log settings are available.

            • NONE: The execute command session is not logged.

            • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.

            • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

            Possible values include:
            • "NONE"
            • "DEFAULT"
            • "OVERRIDE"
          • logConfiguration — (map)

            The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

            • cloudWatchLogGroupName — (String)

              The name of the CloudWatch log group to send logs to.

              Note: The CloudWatch log group must already be created.
            • cloudWatchEncryptionEnabled — (Boolean)

              Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.

            • s3BucketName — (String)

              The name of the S3 bucket to send logs to.

              Note: The S3 bucket must already be created.
            • s3EncryptionEnabled — (Boolean)

              Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.

            • s3KeyPrefix — (String)

              An optional folder in the S3 bucket to place logs in.

        • managedStorageConfiguration — (map)

          The details of the managed storage configuration.

          • kmsKeyId — (String)

            Specify a Key Management Service key ID to encrypt the managed storage.

          • fargateEphemeralStorageKmsKeyId — (String)

            Specify the Key Management Service key ID for the Fargate ephemeral storage.

      • status — (String)

        The status of the cluster. The following are the possible states that are returned.

        ACTIVE

        The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

        PROVISIONING

        The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.

        DEPROVISIONING

        The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.

        FAILED

        The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.

        INACTIVE

        The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

      • registeredContainerInstancesCount — (Integer)

        The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

      • runningTasksCount — (Integer)

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

      • pendingTasksCount — (Integer)

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

      • activeServicesCount — (Integer)

        The number of services that are running on the cluster in an ACTIVE state. You can view these services with PListServices.

      • statistics — (Array<map>)

        Additional information about your clusters that are separated by launch type. They include the following:

        • runningEC2TasksCount

        • RunningFargateTasksCount

        • pendingEC2TasksCount

        • pendingFargateTasksCount

        • activeEC2ServiceCount

        • activeFargateServiceCount

        • drainingEC2ServiceCount

        • drainingFargateServiceCount

        • name — (String)

          The name of the key-value pair. For environment variables, this is the name of the environment variable.

        • value — (String)

          The value of the key-value pair. For environment variables, this is the value of the environment variable.

      • tags — (Array<map>)

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

        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.

        • key — (String)

          One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • value — (String)

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

      • settings — (Array<map>)

        The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off for a cluster.

        • name — (String)

          The name of the cluster setting. The value is containerInsights .

          Possible values include:
          • "containerInsights"
        • value — (String)

          The value to set for the cluster setting. The supported values are enabled and disabled.

          If you set name to containerInsights and value to enabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the containerInsights account setting is turned on. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

      • capacityProviders — (Array<String>)

        The capacity providers associated with the cluster.

      • defaultCapacityProviderStrategy — (Array<map>)

        The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

        • capacityProvider — required — (String)

          The short name of the capacity provider.

        • weight — (Integer)

          The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

          If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

          An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

        • base — (Integer)

          The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

      • attachments — (Array<map>)

        The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.

        • id — (String)

          The unique identifier for the attachment.

        • type — (String)

          The type of the attachment, such as ElasticNetworkInterface, Service Connect, and AmazonElasticBlockStorage.

        • status — (String)

          The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED.

        • details — (Array<map>)

          Details of the attachment.

          For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

          For Service Connect services, this includes portName, clientAliases, discoveryName, and ingressPortOverride.

          For Elastic Block Storage, this includes roleArn, deleteOnTermination, volumeName, volumeId, and statusReason (only when the attachment fails to create or attach).

          • name — (String)

            The name of the key-value pair. For environment variables, this is the name of the environment variable.

          • value — (String)

            The value of the key-value pair. For environment variables, this is the value of the environment variable.

      • attachmentsStatus — (String)

        The status of the capacity providers associated with the cluster. The following are the states that are returned.

        UPDATE_IN_PROGRESS

        The available capacity providers for the cluster are updating.

        UPDATE_COMPLETE

        The capacity providers have successfully updated.

        UPDATE_FAILED

        The capacity provider updates failed.

      • serviceConnectDefaults — (map)

        Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

        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.

        • namespace — (String)

          The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example creates a service in your default region called ``ecs-simple-service``. The service uses the ``hello_world`` task definition and it maintains 10 copies of that task. */

 var params = {
  desiredCount: 10, 
  serviceName: "ecs-simple-service", 
  taskDefinition: "hello_world"
 };
 ecs.createService(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    service: {
     clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/default", 
     createdAt: <Date Representation>, 
     deploymentConfiguration: {
      maximumPercent: 200, 
      minimumHealthyPercent: 100
     }, 
     deployments: [
        {
       createdAt: <Date Representation>, 
       desiredCount: 10, 
       id: "ecs-svc/9223370564342348388", 
       pendingCount: 0, 
       runningCount: 0, 
       status: "PRIMARY", 
       taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", 
       updatedAt: <Date Representation>
      }, 
        {
       createdAt: <Date Representation>, 
       desiredCount: 0, 
       id: "ecs-svc/9223370564343611322", 
       pendingCount: 0, 
       runningCount: 0, 
       status: "ACTIVE", 
       taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", 
       updatedAt: <Date Representation>
      }
     ], 
     desiredCount: 10, 
     events: [
     ], 
     loadBalancers: [
     ], 
     pendingCount: 0, 
     runningCount: 0, 
     serviceArn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service", 
     serviceName: "ecs-simple-service", 
     status: "ACTIVE", 
     taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6"
    }
   }
   */
 });

/* This example creates a service in your default region called ``ecs-simple-service-elb``. The service uses the ``ecs-demo`` task definition and it maintains 10 copies of that task. You must reference an existing load balancer in the same region by its name. */

 var params = {
  desiredCount: 10, 
  loadBalancers: [
     {
    containerName: "simple-app", 
    containerPort: 80, 
    loadBalancerName: "EC2Contai-EcsElast-15DCDAURT3ZO2"
   }
  ], 
  role: "ecsServiceRole", 
  serviceName: "ecs-simple-service-elb", 
  taskDefinition: "console-sample-app-static"
 };
 ecs.createService(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    service: {
     clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/default", 
     createdAt: <Date Representation>, 
     deploymentConfiguration: {
      maximumPercent: 200, 
      minimumHealthyPercent: 100
     }, 
     deployments: [
        {
       createdAt: <Date Representation>, 
       desiredCount: 10, 
       id: "ecs-svc/9223370564343000923", 
       pendingCount: 0, 
       runningCount: 0, 
       status: "PRIMARY", 
       taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6", 
       updatedAt: <Date Representation>
      }
     ], 
     desiredCount: 10, 
     events: [
     ], 
     loadBalancers: [
        {
       containerName: "simple-app", 
       containerPort: 80, 
       loadBalancerName: "EC2Contai-EcsElast-15DCDAURT3ZO2"
      }
     ], 
     pendingCount: 0, 
     roleArn: "arn:aws:iam::012345678910:role/ecsServiceRole", 
     runningCount: 0, 
     serviceArn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service-elb", 
     serviceName: "ecs-simple-service-elb", 
     status: "ACTIVE", 
     taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/console-sample-app-static:6"
    }
   }
   */
 });

var params = {
  serviceName: 'STRING_VALUE', /* required */
  capacityProviderStrategy: [
    {
      capacityProvider: 'STRING_VALUE', /* required */
      base: 'NUMBER_VALUE',
      weight: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  cluster: 'STRING_VALUE',
  deploymentConfiguration: {
    alarms: {
      alarmNames: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      enable: true || false, /* required */
      rollback: true || false /* required */
    },
    deploymentCircuitBreaker: {
      enable: true || false, /* required */
      rollback: true || false /* required */
    },
    maximumPercent: 'NUMBER_VALUE',
    minimumHealthyPercent: 'NUMBER_VALUE'
  },
  deploymentController: {
    type: ECS | CODE_DEPLOY | EXTERNAL /* required */
  },
  desiredCount: 'NUMBER_VALUE',
  enableECSManagedTags: true || false,
  enableExecuteCommand: true || false,
  healthCheckGracePeriodSeconds: 'NUMBER_VALUE',
  launchType: EC2 | FARGATE | EXTERNAL,
  loadBalancers: [
    {
      containerName: 'STRING_VALUE',
      containerPort: 'NUMBER_VALUE',
      loadBalancerName: 'STRING_VALUE',
      targetGroupArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  networkConfiguration: {
    awsvpcConfiguration: {
      subnets: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      assignPublicIp: ENABLED | DISABLED,
      securityGroups: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  placementConstraints: [
    {
      expression: 'STRING_VALUE',
      type: distinctInstance | memberOf
    },
    /* more items */
  ],
  placementStrategy: [
    {
      field: 'STRING_VALUE',
      type: random | spread | binpack
    },
    /* more items */
  ],
  platformVersion: 'STRING_VALUE',
  propagateTags: TASK_DEFINITION | SERVICE | NONE,
  role: 'STRING_VALUE',
  schedulingStrategy: REPLICA | DAEMON,
  serviceConnectConfiguration: {
    enabled: true || false, /* required */
    logConfiguration: {
      logDriver: json-file | syslog | journald | gelf | fluentd | awslogs | splunk | awsfirelens, /* required */
      options: {
        '<String>': 'STRING_VALUE',
        /* '<String>': ... */
      },
      secretOptions: [
        {
          name: 'STRING_VALUE', /* required */
          valueFrom: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    namespace: 'STRING_VALUE',
    services: [
      {
        portName: 'STRING_VALUE', /* required */
        clientAliases: [
          {
            port: 'NUMBER_VALUE', /* required */
            dnsName: 'STRING_VALUE'
          },
          /* more items */
        ],
        discoveryName: 'STRING_VALUE',
        ingressPortOverride: 'NUMBER_VALUE',
        timeout: {
          idleTimeoutSeconds: 'NUMBER_VALUE',
          perRequestTimeoutSeconds: 'NUMBER_VALUE'
        },
        tls: {
          issuerCertificateAuthority: { /* required */
            awsPcaAuthorityArn: 'STRING_VALUE'
          },
          kmsKey: 'STRING_VALUE',
          roleArn: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  },
  serviceRegistries: [
    {
      containerName: 'STRING_VALUE',
      containerPort: 'NUMBER_VALUE',
      port: 'NUMBER_VALUE',
      registryArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  tags: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  taskDefinition: 'STRING_VALUE',
  volumeConfigurations: [
    {
      name: 'STRING_VALUE', /* required */
      managedEBSVolume: {
        roleArn: 'STRING_VALUE', /* required */
        encrypted: true || false,
        filesystemType: ext3 | ext4 | xfs,
        iops: 'NUMBER_VALUE',
        kmsKeyId: 'STRING_VALUE',
        sizeInGiB: 'NUMBER_VALUE',
        snapshotId: 'STRING_VALUE',
        tagSpecifications: [
          {
            resourceType: volume, /* required */
            propagateTags: TASK_DEFINITION | SERVICE | NONE,
            tags: [
              {
                key: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        throughput: 'NUMBER_VALUE',
        volumeType: 'STRING_VALUE'
      }
    },
    /* more items */
  ]
};
ecs.createService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • cluster — (String)

    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 — (String)

    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 — (String)

    The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn't specified, the latest ACTIVE revision is used.

    A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.

    For more information about deployment types, see Amazon ECS deployment types.

  • loadBalancers — (Array<map>)

    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 (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 use 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 uses the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY, and it associates one target group with it. Then, it also 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 you can use to perform validation tests with Lambda functions before routing production traffic to it.

    If you use 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, 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 awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren't supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. This is because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

    • targetGroupArn — (String)

      The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

      A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.

      For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

      For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

      If your service's task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

    • loadBalancerName — (String)

      The name of the load balancer to associate with the Amazon ECS service or task set.

      If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

    • containerName — (String)

      The name of the container (as it appears in a container definition) to associate with the load balancer.

      You need to specify the container name when configuring the target group for an Amazon ECS load balancer.

    • containerPort — (Integer)

      The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.

  • serviceRegistries — (Array<map>)

    The details of the service discovery registry to associate with this service. For more information, see Service discovery.

    Note: Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
    • registryArn — (String)

      The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

    • port — (Integer)

      The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

    • containerName — (String)

      The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

    • containerPort — (Integer)

      The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

  • desiredCount — (Integer)

    The number of instantiations of the specified task definition to place and keep running in your service.

    This is required if schedulingStrategy is REPLICA or isn't specified. If schedulingStrategy is DAEMON then this isn't required.

  • clientToken — (String)

    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 — (String)

    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 launch type runs your tasks on Fargate On-Demand infrastructure.

    Note: 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 EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

    The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

    A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

    Possible values include:
    • "EC2"
    • "FARGATE"
    • "EXTERNAL"
  • capacityProviderStrategy — (Array<map>)

    The capacity provider strategy to use for the service.

    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.

    A capacity provider strategy may contain a maximum of 6 capacity providers.

    • capacityProvider — required — (String)

      The short name of the capacity provider.

    • weight — (Integer)

      The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

      If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

      An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

    • base — (Integer)

      The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

  • platformVersion — (String)

    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. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

  • role — (String)

    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 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 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 don't 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 — (map)

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

    • deploymentCircuitBreaker — (map)
      Note: The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

      The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide

      • enable — required — (Boolean)

        Determines whether to use the deployment circuit breaker logic for the service.

      • rollback — required — (Boolean)

        Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

    • maximumPercent — (Integer)

      If a service is using the rolling update (ECS) deployment type, the maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA service scheduler and has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default maximumPercent value for a service using the REPLICA service scheduler is 200%.

      If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

    • minimumHealthyPercent — (Integer)

      If a service is using the rolling update (ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.

      For services that do not use a load balancer, the following should be noted:

      • A service is considered healthy if all essential containers within the tasks in the service pass their health checks.

      • If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent total.

      • If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.

      For services that do use a load balancer, the following should be noted:

      • If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

      • If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

      The default value for a replica service for minimumHealthyPercent is 100%. The default minimumHealthyPercent value for a service using the DAEMON service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.

      The minimum number of healthy tasks during a deployment is the desiredCount multiplied by the minimumHealthyPercent/100, rounded up to the nearest integer value.

      If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

    • alarms — (map)

      Information about the CloudWatch alarms.

      • alarmNames — required — (Array<String>)

        One or more CloudWatch alarm names. Use a "," to separate the alarms.

      • enable — required — (Boolean)

        Determines whether to use the CloudWatch alarm option in the service deployment process.

      • rollback — required — (Boolean)

        Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

  • placementConstraints — (Array<map>)

    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.

    • type — (String)

      The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

      Possible values include:
      • "distinctInstance"
      • "memberOf"
    • expression — (String)

      A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

  • placementStrategy — (Array<map>)

    The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.

    • type — (String)

      The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

      Possible values include:
      • "random"
      • "spread"
      • "binpack"
    • field — (String)

      The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

  • networkConfiguration — (map)

    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 isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

    • awsvpcConfiguration — (map)

      The VPC subnets and security groups that are associated with a task.

      Note: All specified subnets and security groups must be from the same VPC.
      • subnets — required — (Array<String>)

        The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per awsvpcConfiguration.

        Note: All specified subnets must be from the same VPC.
      • securityGroups — (Array<String>)

        The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per awsvpcConfiguration.

        Note: All specified security groups must be from the same VPC.
      • assignPublicIp — (String)

        Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
  • healthCheckGracePeriodSeconds — (Integer)

    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 0 is used.

    If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in the task definition health check parameters. For more information, see Health check.

    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 — (String)

    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 uses the CODE_DEPLOY or EXTERNAL 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 don't 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.

      Note: Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
    Possible values include:
    • "REPLICA"
    • "DAEMON"
  • deploymentController — (map)

    The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

    • type — required — (String)

      The deployment controller type to use.

      There are three deployment controller types available:

      ECS

      The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.

      CODE_DEPLOY

      The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.

      EXTERNAL

      The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

      Possible values include:
      • "ECS"
      • "CODE_DEPLOY"
      • "EXTERNAL"
  • tags — (Array<map>)

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

    • key — (String)

      One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

    • value — (String)

      The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

  • enableECSManagedTags — (Boolean)

    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 request parameter.

  • propagateTags — (String)

    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 TagResource API action.

    You must set this to a value other than NONE when you use Cost Explorer. For more information, see Amazon ECS usage reports in the Amazon Elastic Container Service Developer Guide.

    The default is NONE.

    Possible values include:
    • "TASK_DEFINITION"
    • "SERVICE"
    • "NONE"
  • enableExecuteCommand — (Boolean)

    Determines whether the execute command functionality is turned on for the service. If true, this enables execute command functionality on all containers in the service tasks.

  • serviceConnectConfiguration — (map)

    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.

    • enabled — required — (Boolean)

      Specifies whether to use Service Connect with this service.

    • namespace — (String)

      The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.

    • services — (Array<map>)

      The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

      This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

      An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

      • portName — required — (String)

        The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.

      • discoveryName — (String)

        The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

        If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

      • clientAliases — (Array<map>)

        The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.

        Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.

        Each name and port mapping must be unique within the namespace.

        For each ServiceConnectService, you must provide at least one clientAlias with one port.

        • port — required — (Integer)

          The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.

          To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

        • dnsName — (String)

          The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.

          If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

          To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

      • ingressPortOverride — (Integer)

        The port number for the Service Connect proxy to listen on.

        Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.

        In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.

      • timeout — (map)

        A reference to an object that represents the configured timeouts for Service Connect.

        • idleTimeoutSeconds — (Integer)

          The amount of time in seconds a connection will stay active while idle. A value of 0 can be set to disable idleTimeout.

          The idleTimeout default for HTTP/HTTP2/GRPC is 5 minutes.

          The idleTimeout default for TCP is 1 hour.

        • perRequestTimeoutSeconds — (Integer)

          The amount of time waiting for the upstream to respond with a complete response per request. A value of 0 can be set to disable perRequestTimeout. perRequestTimeout can only be set if Service Connect appProtocol isn't TCP. Only idleTimeout is allowed for TCP appProtocol.

      • tls — (map)

        A reference to an object that represents a Transport Layer Security (TLS) configuration.

        • issuerCertificateAuthority — required — (map)

          The signer certificate authority.

          • awsPcaAuthorityArn — (String)

            The ARN of the Amazon Web Services Private Certificate Authority certificate.

        • kmsKey — (String)

          The Amazon Web Services Key Management Service key.

        • roleArn — (String)

          The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.

    • logConfiguration — (map)

      The log configuration for the container. This parameter maps to LogConfig in the docker conainer create command and the --log-driver option to docker run.

      By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition.

      Understand the following when specifying a log configuration for your containers.

      • Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.

        For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

        For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald,syslog, splunk, and awsfirelens.

      • This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.

      • For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

      • For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.

      • logDriver — required — (String)

        The log driver to use for the container.

        For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

        For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, syslog, splunk, and awsfirelens.

        For more information about using the awslogs log driver, see Send Amazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.

        For more information about using the awsfirelens log driver, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.

        Note: If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.
        Possible values include:
        • "json-file"
        • "syslog"
        • "journald"
        • "gelf"
        • "fluentd"
        • "awslogs"
        • "splunk"
        • "awsfirelens"
      • options — (map<String>)

        The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

      • secretOptions — (Array<map>)

        The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

        • name — required — (String)

          The name of the secret.

        • valueFrom — required — (String)

          The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

          For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.

          Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
  • volumeConfigurations — (Array<map>)

    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.

    • name — required — (String)

      The name of the volume. This value must match the volume name from the Volume object in the task definition.

    • managedEBSVolume — (map)

      The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.

      • encrypted — (Boolean)

        Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.

      • kmsKeyId — (String)

        The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference.

        Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.

      • volumeType — (String)

        The volume type. This parameter maps 1:1 with the VolumeType parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.

        The following are the supported volume types.

        • General Purpose SSD: gp2|gp3

        • Provisioned IOPS SSD: io1|io2

        • Throughput Optimized HDD: st1

        • Cold HDD: sc1

        • Magnetic: standard

          Note: The magnetic volume type is not supported on Fargate.
      • sizeInGiB — (Integer)

        The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.

        The following are the supported volume size values for each volume type.

        • gp2 and gp3: 1-16,384

        • io1 and io2: 4-16,384

        • st1 and sc1: 125-16,384

        • standard: 1-1,024

      • snapshotId — (String)

        The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.

      • iops — (Integer)

        The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

        The following are the supported values for each volume type.

        • gp3: 3,000 - 16,000 IOPS

        • io1: 100 - 64,000 IOPS

        • io2: 100 - 256,000 IOPS

        This parameter is required for io1 and io2 volume types. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for st1, sc1, or standard volume types.

        This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.

      • throughput — (Integer)

        The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.

        This parameter is only supported for the gp3 volume type.

      • tagSpecifications — (Array<map>)

        The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.

        • resourceType — required — (String)

          The type of volume resource.

          Possible values include:
          • "volume"
        • tags — (Array<map>)

          The tags applied to this Amazon EBS volume. AmazonECSCreated and AmazonECSManaged are reserved tags that can't be used.

          • key — (String)

            One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

          • value — (String)

            The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

        • propagateTags — (String)

          Determines whether to propagate the tags from the task definition to 
the Amazon EBS volume. Tags can only propagate to a SERVICE specified in 
ServiceVolumeConfiguration. If no value is specified, the tags aren't 
propagated.

          Possible values include:
          • "TASK_DEFINITION"
          • "SERVICE"
          • "NONE"
      • roleArn — required — (String)

        The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.

      • filesystemType — (String)

        The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.

        The available filesystem types are
 ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.

        Possible values include:
        • "ext3"
        • "ext4"
        • "xfs"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • service — (map)

      The full description of your service following the create call.

      A service will return either a capacityProviderStrategy or launchType parameter, but not both, depending where one was specified when it was created.

      If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned.

      if the service uses the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list.

      • serviceArn — (String)

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

      • serviceName — (String)

        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.

      • clusterArn — (String)

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

      • loadBalancers — (Array<map>)

        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.

        • targetGroupArn — (String)

          The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

          A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.

          For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

          For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

          If your service's task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

        • loadBalancerName — (String)

          The name of the load balancer to associate with the Amazon ECS service or task set.

          If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

        • containerName — (String)

          The name of the container (as it appears in a container definition) to associate with the load balancer.

          You need to specify the container name when configuring the target group for an Amazon ECS load balancer.

        • containerPort — (Integer)

          The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.

      • serviceRegistries — (Array<map>)

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

        • registryArn — (String)

          The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

        • port — (Integer)

          The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

        • containerName — (String)

          The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

        • containerPort — (Integer)

          The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

      • status — (String)

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

      • desiredCount — (Integer)

        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.

      • runningCount — (Integer)

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

      • pendingCount — (Integer)

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

      • launchType — (String)

        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.

        Possible values include:
        • "EC2"
        • "FARGATE"
        • "EXTERNAL"
      • capacityProviderStrategy — (Array<map>)

        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.

        • capacityProvider — required — (String)

          The short name of the capacity provider.

        • weight — (Integer)

          The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

          If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

          An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

        • base — (Integer)

          The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

      • platformVersion — (String)

        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.

      • platformFamily — (String)

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

      • taskDefinition — (String)

        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.

      • deploymentConfiguration — (map)

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

        • deploymentCircuitBreaker — (map)
          Note: The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

          The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide

          • enable — required — (Boolean)

            Determines whether to use the deployment circuit breaker logic for the service.

          • rollback — required — (Boolean)

            Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

        • maximumPercent — (Integer)

          If a service is using the rolling update (ECS) deployment type, the maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA service scheduler and has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default maximumPercent value for a service using the REPLICA service scheduler is 200%.

          If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

        • minimumHealthyPercent — (Integer)

          If a service is using the rolling update (ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.

          For services that do not use a load balancer, the following should be noted:

          • A service is considered healthy if all essential containers within the tasks in the service pass their health checks.

          • If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent total.

          • If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.

          For services that do use a load balancer, the following should be noted:

          • If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

          • If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

          The default value for a replica service for minimumHealthyPercent is 100%. The default minimumHealthyPercent value for a service using the DAEMON service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.

          The minimum number of healthy tasks during a deployment is the desiredCount multiplied by the minimumHealthyPercent/100, rounded up to the nearest integer value.

          If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

        • alarms — (map)

          Information about the CloudWatch alarms.

          • alarmNames — required — (Array<String>)

            One or more CloudWatch alarm names. Use a "," to separate the alarms.

          • enable — required — (Boolean)

            Determines whether to use the CloudWatch alarm option in the service deployment process.

          • rollback — required — (Boolean)

            Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

      • taskSets — (Array<map>)

        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.

        • id — (String)

          The ID of the task set.

        • taskSetArn — (String)

          The Amazon Resource Name (ARN) of the task set.

        • serviceArn — (String)

          The Amazon Resource Name (ARN) of the service the task set exists in.

        • clusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

        • startedBy — (String)

          The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.

        • externalId — (String)

          The external ID associated with the task set.

          If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.

          If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

        • status — (String)

          The status of the task set. The following describes each state.

          PRIMARY

          The task set is serving production traffic.

          ACTIVE

          The task set isn't serving production traffic.

          DRAINING

          The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.

        • taskDefinition — (String)

          The task definition that the task set is using.

        • computedDesiredCount — (Integer)

          The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

        • pendingCount — (Integer)

          The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it's restarted after being in the STOPPED state.

        • runningCount — (Integer)

          The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

        • createdAt — (Date)

          The Unix timestamp for the time when the task set was created.

        • updatedAt — (Date)

          The Unix timestamp for the time when the task set was last updated.

        • launchType — (String)

          The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

          Possible values include:
          • "EC2"
          • "FARGATE"
          • "EXTERNAL"
        • capacityProviderStrategy — (Array<map>)

          The capacity provider strategy that are associated with the task set.

          • capacityProvider — required — (String)

            The short name of the capacity provider.

          • weight — (Integer)

            The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

            If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

            An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

          • base — (Integer)

            The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

        • platformVersion — (String)

          The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

        • platformFamily — (String)

          The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.

          All tasks in the set must have the same value.

        • networkConfiguration — (map)

          The network configuration for the task set.

          • awsvpcConfiguration — (map)

            The VPC subnets and security groups that are associated with a task.

            Note: All specified subnets and security groups must be from the same VPC.
            • subnets — required — (Array<String>)

              The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per awsvpcConfiguration.

              Note: All specified subnets must be from the same VPC.
            • securityGroups — (Array<String>)

              The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per awsvpcConfiguration.

              Note: All specified security groups must be from the same VPC.
            • assignPublicIp — (String)

              Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
        • loadBalancers — (Array<map>)

          Details on a load balancer that are used with a task set.

          • targetGroupArn — (String)

            The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

            A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.

            For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

            For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

            If your service's task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

          • loadBalancerName — (String)

            The name of the load balancer to associate with the Amazon ECS service or task set.

            If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

          • containerName — (String)

            The name of the container (as it appears in a container definition) to associate with the load balancer.

            You need to specify the container name when configuring the target group for an Amazon ECS load balancer.

          • containerPort — (Integer)

            The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.

        • serviceRegistries — (Array<map>)

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

          • registryArn — (String)

            The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

          • port — (Integer)

            The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

          • containerName — (String)

            The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

          • containerPort — (Integer)

            The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

        • scale — (map)

          A floating-point percentage of your desired number of tasks to place and keep running in the task set.

          • value — (Float)

            The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.

          • unit — (String)

            The unit of measure for the scale value.

            Possible values include:
            • "PERCENT"
        • stabilityStatus — (String)

          The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in STEADY_STATE:

          • The task runningCount is equal to the computedDesiredCount.

          • The pendingCount is 0.

          • There are no tasks that are running on container instances in the DRAINING status.

          • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

          If any of those conditions aren't met, the stability status returns STABILIZING.

          Possible values include:
          • "STEADY_STATE"
          • "STABILIZING"
        • stabilityStatusAt — (Date)

          The Unix timestamp for the time when the task set stability status was retrieved.

        • tags — (Array<map>)

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

          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.

          • key — (String)

            One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

          • value — (String)

            The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

        • fargateEphemeralStorage — (map)

          The Fargate ephemeral storage settings for the task set.

          • kmsKeyId — (String)

            Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.

      • deployments — (Array<map>)

        The current state of deployments for the service.

        • id — (String)

          The ID of the deployment.

        • status — (String)

          The status of the deployment. The following describes each state.

          PRIMARY

          The most recent deployment of a service.

          ACTIVE

          A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

          INACTIVE

          A deployment that has been completely replaced.

        • taskDefinition — (String)

          The most recent task definition that was specified for the tasks in the service to use.

        • desiredCount — (Integer)

          The most recent desired count of tasks that was specified for the service to deploy or maintain.

        • pendingCount — (Integer)

          The number of tasks in the deployment that are in the PENDING status.

        • runningCount — (Integer)

          The number of tasks in the deployment that are in the RUNNING status.

        • failedTasks — (Integer)

          The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

          Note: Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
        • createdAt — (Date)

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

        • updatedAt — (Date)

          The Unix timestamp for the time when the service deployment was last updated.

        • capacityProviderStrategy — (Array<map>)

          The capacity provider strategy that the deployment is using.

          • capacityProvider — required — (String)

            The short name of the capacity provider.

          • weight — (Integer)

            The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

            If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

            An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

          • base — (Integer)

            The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

        • launchType — (String)

          The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

          Possible values include:
          • "EC2"
          • "FARGATE"
          • "EXTERNAL"
        • platformVersion — (String)

          The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. 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.

        • platformFamily — (String)

          The operating system that your tasks in the service, or tasks are running 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..

        • networkConfiguration — (map)

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

          • awsvpcConfiguration — (map)

            The VPC subnets and security groups that are associated with a task.

            Note: All specified subnets and security groups must be from the same VPC.
            • subnets — required — (Array<String>)

              The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per awsvpcConfiguration.

              Note: All specified subnets must be from the same VPC.
            • securityGroups — (Array<String>)

              The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per awsvpcConfiguration.

              Note: All specified security groups must be from the same VPC.
            • assignPublicIp — (String)

              Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
        • rolloutState — (String)
          Note: The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.

          The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

          Possible values include:
          • "COMPLETED"
          • "FAILED"
          • "IN_PROGRESS"
        • rolloutStateReason — (String)

          A description of the rollout state of a deployment.

        • serviceConnectConfiguration — (map)

          The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

          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.

          • enabled — required — (Boolean)

            Specifies whether to use Service Connect with this service.

          • namespace — (String)

            The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.

          • services — (Array<map>)

            The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

            This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

            An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

            • portName — required — (String)

              The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.

            • discoveryName — (String)

              The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

              If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

            • clientAliases — (Array<map>)

              The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.

              Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.

              Each name and port mapping must be unique within the namespace.

              For each ServiceConnectService, you must provide at least one clientAlias with one port.

              • port — required — (Integer)

                The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.

                To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

              • dnsName — (String)

                The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.

                If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

                To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

            • ingressPortOverride — (Integer)

              The port number for the Service Connect proxy to listen on.

              Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.

              In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.

            • timeout — (map)

              A reference to an object that represents the configured timeouts for Service Connect.

              • idleTimeoutSeconds — (Integer)

                The amount of time in seconds a connection will stay active while idle. A value of 0 can be set to disable idleTimeout.

                The idleTimeout default for HTTP/HTTP2/GRPC is 5 minutes.

                The idleTimeout default for TCP is 1 hour.

              • perRequestTimeoutSeconds — (Integer)

                The amount of time waiting for the upstream to respond with a complete response per request. A value of 0 can be set to disable perRequestTimeout. perRequestTimeout can only be set if Service Connect appProtocol isn't TCP. Only idleTimeout is allowed for TCP appProtocol.

            • tls — (map)

              A reference to an object that represents a Transport Layer Security (TLS) configuration.

              • issuerCertificateAuthority — required — (map)

                The signer certificate authority.

                • awsPcaAuthorityArn — (String)

                  The ARN of the Amazon Web Services Private Certificate Authority certificate.

              • kmsKey — (String)

                The Amazon Web Services Key Management Service key.

              • roleArn — (String)

                The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.

          • logConfiguration — (map)

            The log configuration for the container. This parameter maps to LogConfig in the docker conainer create command and the --log-driver option to docker run.

            By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition.

            Understand the following when specifying a log configuration for your containers.

            • Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.

              For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

              For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald,syslog, splunk, and awsfirelens.

            • This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.

            • For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

            • For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.

            • logDriver — required — (String)

              The log driver to use for the container.

              For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

              For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, syslog, splunk, and awsfirelens.

              For more information about using the awslogs log driver, see Send Amazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.

              For more information about using the awsfirelens log driver, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.

              Note: If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.
              Possible values include:
              • "json-file"
              • "syslog"
              • "journald"
              • "gelf"
              • "fluentd"
              • "awslogs"
              • "splunk"
              • "awsfirelens"
            • options — (map<String>)

              The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

            • secretOptions — (Array<map>)

              The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

              • name — required — (String)

                The name of the secret.

              • valueFrom — required — (String)

                The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

                For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.

                Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
        • serviceConnectResources — (Array<map>)

          The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

          • discoveryName — (String)

            The discovery name of this Service Connect resource.

            The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

            If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

          • discoveryArn — (String)

            The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.

        • volumeConfigurations — (Array<map>)

          The details of the volume that was configuredAtLaunch. You can configure different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

          • name — required — (String)

            The name of the volume. This value must match the volume name from the Volume object in the task definition.

          • managedEBSVolume — (map)

            The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.

            • encrypted — (Boolean)

              Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.

            • kmsKeyId — (String)

              The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference.

              Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.

            • volumeType — (String)

              The volume type. This parameter maps 1:1 with the VolumeType parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.

              The following are the supported volume types.

              • General Purpose SSD: gp2|gp3

              • Provisioned IOPS SSD: io1|io2

              • Throughput Optimized HDD: st1

              • Cold HDD: sc1

              • Magnetic: standard

                Note: The magnetic volume type is not supported on Fargate.
            • sizeInGiB — (Integer)

              The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.

              The following are the supported volume size values for each volume type.

              • gp2 and gp3: 1-16,384

              • io1 and io2: 4-16,384

              • st1 and sc1: 125-16,384

              • standard: 1-1,024

            • snapshotId — (String)

              The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.

            • iops — (Integer)

              The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

              The following are the supported values for each volume type.

              • gp3: 3,000 - 16,000 IOPS

              • io1: 100 - 64,000 IOPS

              • io2: 100 - 256,000 IOPS

              This parameter is required for io1 and io2 volume types. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for st1, sc1, or standard volume types.

              This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.

            • throughput — (Integer)

              The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.

              This parameter is only supported for the gp3 volume type.

            • tagSpecifications — (Array<map>)

              The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.

              • resourceType — required — (String)

                The type of volume resource.

                Possible values include:
                • "volume"
              • tags — (Array<map>)

                The tags applied to this Amazon EBS volume. AmazonECSCreated and AmazonECSManaged are reserved tags that can't be used.

                • key — (String)

                  One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

                • value — (String)

                  The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

              • propagateTags — (String)

                Determines whether to propagate the tags from the task definition to 
the Amazon EBS volume. Tags can only propagate to a SERVICE specified in 
ServiceVolumeConfiguration. If no value is specified, the tags aren't 
propagated.

                Possible values include:
                • "TASK_DEFINITION"
                • "SERVICE"
                • "NONE"
            • roleArn — required — (String)

              The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.

            • filesystemType — (String)

              The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.

              The available filesystem types are
 ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.

              Possible values include:
              • "ext3"
              • "ext4"
              • "xfs"
        • fargateEphemeralStorage — (map)

          The Fargate ephemeral storage settings for the deployment.

          • kmsKeyId — (String)

            Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.

      • roleArn — (String)

        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.

      • events — (Array<map>)

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

        • id — (String)

          The ID string for the event.

        • createdAt — (Date)

          The Unix timestamp for the time when the event was triggered.

        • message — (String)

          The event message.

      • createdAt — (Date)

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

      • placementConstraints — (Array<map>)

        The placement constraints for the tasks in the service.

        • type — (String)

          The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

          Possible values include:
          • "distinctInstance"
          • "memberOf"
        • expression — (String)

          A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

      • placementStrategy — (Array<map>)

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

        • type — (String)

          The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

          Possible values include:
          • "random"
          • "spread"
          • "binpack"
        • field — (String)

          The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

      • networkConfiguration — (map)

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

        • awsvpcConfiguration — (map)

          The VPC subnets and security groups that are associated with a task.

          Note: All specified subnets and security groups must be from the same VPC.
          • subnets — required — (Array<String>)

            The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per awsvpcConfiguration.

            Note: All specified subnets must be from the same VPC.
          • securityGroups — (Array<String>)

            The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per awsvpcConfiguration.

            Note: All specified security groups must be from the same VPC.
          • assignPublicIp — (String)

            Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
      • healthCheckGracePeriodSeconds — (Integer)

        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.

      • schedulingStrategy — (String)

        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.

          Note: Fargate tasks don't support the DAEMON scheduling strategy.
        Possible values include:
        • "REPLICA"
        • "DAEMON"
      • deploymentController — (map)

        The deployment controller type the service is using.

        • type — required — (String)

          The deployment controller type to use.

          There are three deployment controller types available:

          ECS

          The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.

          CODE_DEPLOY

          The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.

          EXTERNAL

          The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

          Possible values include:
          • "ECS"
          • "CODE_DEPLOY"
          • "EXTERNAL"
      • tags — (Array<map>)

        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.

        • key — (String)

          One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • value — (String)

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

      • createdBy — (String)

        The principal that created the service.

      • enableECSManagedTags — (Boolean)

        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.

      • propagateTags — (String)

        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.

        Possible values include:
        • "TASK_DEFINITION"
        • "SERVICE"
        • "NONE"
      • enableExecuteCommand — (Boolean)

        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:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  cluster: 'STRING_VALUE', /* required */
  service: 'STRING_VALUE', /* required */
  taskDefinition: 'STRING_VALUE', /* required */
  capacityProviderStrategy: [
    {
      capacityProvider: 'STRING_VALUE', /* required */
      base: 'NUMBER_VALUE',
      weight: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  externalId: 'STRING_VALUE',
  launchType: EC2 | FARGATE | EXTERNAL,
  loadBalancers: [
    {
      containerName: 'STRING_VALUE',
      containerPort: 'NUMBER_VALUE',
      loadBalancerName: 'STRING_VALUE',
      targetGroupArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  networkConfiguration: {
    awsvpcConfiguration: {
      subnets: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      assignPublicIp: ENABLED | DISABLED,
      securityGroups: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  platformVersion: 'STRING_VALUE',
  scale: {
    unit: PERCENT,
    value: 'NUMBER_VALUE'
  },
  serviceRegistries: [
    {
      containerName: 'STRING_VALUE',
      containerPort: 'NUMBER_VALUE',
      port: 'NUMBER_VALUE',
      registryArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  tags: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ecs.createTaskSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • service — (String)

    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

  • cluster — (String)

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

  • externalId — (String)

    An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided value.

  • taskDefinition — (String)

    The task definition for the tasks in the task set to use. If a revision isn't specified, the latest ACTIVE revision is used.

  • networkConfiguration — (map)

    An object representing the network configuration for a task set.

    • awsvpcConfiguration — (map)

      The VPC subnets and security groups that are associated with a task.

      Note: All specified subnets and security groups must be from the same VPC.
      • subnets — required — (Array<String>)

        The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per awsvpcConfiguration.

        Note: All specified subnets must be from the same VPC.
      • securityGroups — (Array<String>)

        The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per awsvpcConfiguration.

        Note: All specified security groups must be from the same VPC.
      • assignPublicIp — (String)

        Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
  • loadBalancers — (Array<map>)

    A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

    • targetGroupArn — (String)

      The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

      A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.

      For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

      For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

      If your service's task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

    • loadBalancerName — (String)

      The name of the load balancer to associate with the Amazon ECS service or task set.

      If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

    • containerName — (String)

      The name of the container (as it appears in a container definition) to associate with the load balancer.

      You need to specify the container name when configuring the target group for an Amazon ECS load balancer.

    • containerPort — (Integer)

      The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.

  • serviceRegistries — (Array<map>)

    The details of the service discovery registries to assign to this task set. For more information, see Service discovery.

    • registryArn — (String)

      The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

    • port — (Integer)

      The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

    • containerName — (String)

      The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

    • containerPort — (Integer)

      The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

  • launchType — (String)

    The launch type that new tasks in the task set uses. 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.

    Possible values include:
    • "EC2"
    • "FARGATE"
    • "EXTERNAL"
  • capacityProviderStrategy — (Array<map>)

    The capacity provider strategy to use for the task set.

    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 CreateCapacityProviderProviderAPI operation.

    To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The 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.

    • capacityProvider — required — (String)

      The short name of the capacity provider.

    • weight — (Integer)

      The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

      If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

      An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

    • base — (Integer)

      The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

  • platformVersion — (String)

    The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used.

  • scale — (map)

    A floating-point percentage of the desired number of tasks to place and keep running in the task set.

    • value — (Float)

      The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.

    • unit — (String)

      The unit of measure for the scale value.

      Possible values include:
      • "PERCENT"
  • clientToken — (String)

    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.

  • tags — (Array<map>)

    The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. When a service is deleted, the tags are deleted.

    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.

    • key — (String)

      One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

    • value — (String)

      The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • taskSet — (map)

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

      • id — (String)

        The ID of the task set.

      • taskSetArn — (String)

        The Amazon Resource Name (ARN) of the task set.

      • serviceArn — (String)

        The Amazon Resource Name (ARN) of the service the task set exists in.

      • clusterArn — (String)

        The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

      • startedBy — (String)

        The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.

      • externalId — (String)

        The external ID associated with the task set.

        If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.

        If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

      • status — (String)

        The status of the task set. The following describes each state.

        PRIMARY

        The task set is serving production traffic.

        ACTIVE

        The task set isn't serving production traffic.

        DRAINING

        The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.

      • taskDefinition — (String)

        The task definition that the task set is using.

      • computedDesiredCount — (Integer)

        The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

      • pendingCount — (Integer)

        The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it's restarted after being in the STOPPED state.

      • runningCount — (Integer)

        The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

      • createdAt — (Date)

        The Unix timestamp for the time when the task set was created.

      • updatedAt — (Date)

        The Unix timestamp for the time when the task set was last updated.

      • launchType — (String)

        The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

        Possible values include:
        • "EC2"
        • "FARGATE"
        • "EXTERNAL"
      • capacityProviderStrategy — (Array<map>)

        The capacity provider strategy that are associated with the task set.

        • capacityProvider — required — (String)

          The short name of the capacity provider.

        • weight — (Integer)

          The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

          If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

          An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

        • base — (Integer)

          The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

      • platformVersion — (String)

        The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

      • platformFamily — (String)

        The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.

        All tasks in the set must have the same value.

      • networkConfiguration — (map)

        The network configuration for the task set.

        • awsvpcConfiguration — (map)

          The VPC subnets and security groups that are associated with a task.

          Note: All specified subnets and security groups must be from the same VPC.
          • subnets — required — (Array<String>)

            The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per awsvpcConfiguration.

            Note: All specified subnets must be from the same VPC.
          • securityGroups — (Array<String>)

            The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per awsvpcConfiguration.

            Note: All specified security groups must be from the same VPC.
          • assignPublicIp — (String)

            Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
      • loadBalancers — (Array<map>)

        Details on a load balancer that are used with a task set.

        • targetGroupArn — (String)

          The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

          A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.

          For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

          For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

          If your service's task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

        • loadBalancerName — (String)

          The name of the load balancer to associate with the Amazon ECS service or task set.

          If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

        • containerName — (String)

          The name of the container (as it appears in a container definition) to associate with the load balancer.

          You need to specify the container name when configuring the target group for an Amazon ECS load balancer.

        • containerPort — (Integer)

          The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.

      • serviceRegistries — (Array<map>)

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

        • registryArn — (String)

          The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

        • port — (Integer)

          The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

        • containerName — (String)

          The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

        • containerPort — (Integer)

          The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

      • scale — (map)

        A floating-point percentage of your desired number of tasks to place and keep running in the task set.

        • value — (Float)

          The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.

        • unit — (String)

          The unit of measure for the scale value.

          Possible values include:
          • "PERCENT"
      • stabilityStatus — (String)

        The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in STEADY_STATE:

        • The task runningCount is equal to the computedDesiredCount.

        • The pendingCount is 0.

        • There are no tasks that are running on container instances in the DRAINING status.

        • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

        If any of those conditions aren't met, the stability status returns STABILIZING.

        Possible values include:
        • "STEADY_STATE"
        • "STABILIZING"
      • stabilityStatusAt — (Date)

        The Unix timestamp for the time when the task set stability status was retrieved.

      • tags — (Array<map>)

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

        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.

        • key — (String)

          One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • value — (String)

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

      • fargateEphemeralStorage — (map)

        The Fargate ephemeral storage settings for the task set.

        • kmsKeyId — (String)

          Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes the account setting for your user for the specified resource type. */

 var params = {
  name: "serviceLongArnFormat"
 };
 ecs.deleteAccountSetting(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    setting: {
     name: "serviceLongArnFormat", 
     value: "enabled", 
     principalArn: "arn:aws:iam::<aws_account_id>:user/principalName"
    }
   }
   */
 });

/* This example deletes the account setting for a specific IAM user or IAM role for the specified resource type. Only the root user can view or modify the account settings for another user. */

 var params = {
  name: "containerInstanceLongArnFormat", 
  principalArn: "arn:aws:iam::<aws_account_id>:user/principalName"
 };
 ecs.deleteAccountSetting(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    setting: {
     name: "containerInstanceLongArnFormat", 
     value: "enabled", 
     principalArn: "arn:aws:iam::<aws_account_id>:user/principalName"
    }
   }
   */
 });

var params = {
  name: serviceLongArnFormat | taskLongArnFormat | containerInstanceLongArnFormat | awsvpcTrunking | containerInsights | fargateFIPSMode | tagResourceAuthorization | fargateTaskRetirementWaitPeriod | guardDutyActivate, /* required */
  principalArn: 'STRING_VALUE'
};
ecs.deleteAccountSetting(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The resource name to disable the account setting for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.

    Possible values include:
    • "serviceLongArnFormat"
    • "taskLongArnFormat"
    • "containerInstanceLongArnFormat"
    • "awsvpcTrunking"
    • "containerInsights"
    • "fargateFIPSMode"
    • "tagResourceAuthorization"
    • "fargateTaskRetirementWaitPeriod"
    • "guardDutyActivate"
  • principalArn — (String)

    The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • setting — (map)

      The account setting for the specified principal ARN.

      • name — (String)

        The Amazon ECS resource name.

        Possible values include:
        • "serviceLongArnFormat"
        • "taskLongArnFormat"
        • "containerInstanceLongArnFormat"
        • "awsvpcTrunking"
        • "containerInsights"
        • "fargateFIPSMode"
        • "tagResourceAuthorization"
        • "fargateTaskRetirementWaitPeriod"
        • "guardDutyActivate"
      • value — (String)

        Determines whether the account setting is on or off for the specified resource.

      • principalArn — (String)

        The ARN of the principal. It can be a user, role, or the root user. If this field is omitted, the authenticated user is assumed.

      • type — (String)

        Indicates whether Amazon Web Services manages the account setting, or if the user manages it.

        aws_managed account settings are read-only, as Amazon Web Services manages such on the customer's behalf. Currently, the guardDutyActivate account setting is the only one Amazon Web Services manages.

        Possible values include:
        • "user"
        • "aws_managed"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  attributes: [ /* required */
    {
      name: 'STRING_VALUE', /* required */
      targetId: 'STRING_VALUE',
      targetType: container-instance,
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  cluster: 'STRING_VALUE'
};
ecs.deleteAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • cluster — (String)

    The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.

  • attributes — (Array<map>)

    The attributes to delete from your resource. You can specify up to 10 attributes for each request. For custom attributes, specify the attribute name and target ID, but don't specify the value. If you specify the target ID using the short form, you must also specify the target type.

    • name — required — (String)

      The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).

    • value — (String)

      The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can't start or end with a space.

    • targetType — (String)

      The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

      Possible values include:
      • "container-instance"
    • targetId — (String)

      The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • attributes — (Array<map>)

      A list of attribute objects that were successfully deleted from your resource.

      • name — required — (String)

        The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).

      • value — (String)

        The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can't start or end with a space.

      • targetType — (String)

        The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

        Possible values include:
        • "container-instance"
      • targetId — (String)

        The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  capacityProvider: 'STRING_VALUE' /* required */
};
ecs.deleteCapacityProvider(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • capacityProvider — (String)

    The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • capacityProvider — (map)

      The details of the capacity provider.

      • capacityProviderArn — (String)

        The Amazon Resource Name (ARN) that identifies the capacity provider.

      • name — (String)

        The name of the capacity provider.

      • status — (String)

        The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • autoScalingGroupProvider — (map)

        The Auto Scaling group settings for the capacity provider.

        • autoScalingGroupArn — required — (String)

          The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.

        • managedScaling — (map)

          The managed scaling settings for the Auto Scaling group capacity provider.

          • status — (String)

            Determines whether to use managed scaling for the capacity provider.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • targetCapacity — (Integer)

            The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use a targetCapacity of 90. The default value of 100 percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.

          • minimumScalingStepSize — (Integer)

            The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.

            When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

            If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

          • maximumScalingStepSize — (Integer)

            The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default value of 10000 is used.

          • instanceWarmupPeriod — (Integer)

            The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is used.

        • managedTerminationProtection — (String)

          The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.

          When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

          When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.

          When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • managedDraining — (String)

          The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • updateStatus — (String)

        The update status of the capacity provider. The following are the possible states that is returned.

        DELETE_IN_PROGRESS

        The capacity provider is in the process of being deleted.

        DELETE_COMPLETE

        The capacity provider was successfully deleted and has an INACTIVE status.

        DELETE_FAILED

        The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

        Possible values include:
        • "DELETE_IN_PROGRESS"
        • "DELETE_COMPLETE"
        • "DELETE_FAILED"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_COMPLETE"
        • "UPDATE_FAILED"
      • updateStatusReason — (String)

        The update status reason. This provides further details about the update status for the capacity provider.

      • tags — (Array<map>)

        The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

        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.

        • key — (String)

          One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • value — (String)

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes an empty cluster in your default region. */

 var params = {
  cluster: "my_cluster"
 };
 ecs.deleteCluster(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    cluster: {
     activeServicesCount: 0, 
     clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", 
     clusterName: "my_cluster", 
     pendingTasksCount: 0, 
     registeredContainerInstancesCount: 0, 
     runningTasksCount: 0, 
     status: "INACTIVE"
    }
   }
   */
 });

var params = {
  cluster: 'STRING_VALUE' /* required */
};
ecs.deleteCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • cluster — (String)

    The short name or full Amazon Resource Name (ARN) of the cluster to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • cluster — (map)

      The full description of the deleted cluster.

      • clusterArn — (String)

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

      • clusterName — (String)

        A user-generated string that you use to identify your cluster.

      • configuration — (map)

        The execute command configuration for the cluster.

        • executeCommandConfiguration — (map)

          The details of the execute command configuration.

          • kmsKeyId — (String)

            Specify an Key Management Service key ID to encrypt the data between the local client and the container.

          • logging — (String)

            The log setting to use for redirecting logs for your execute command results. The following log settings are available.

            • NONE: The execute command session is not logged.

            • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.

            • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

            Possible values include:
            • "NONE"
            • "DEFAULT"
            • "OVERRIDE"
          • logConfiguration — (map)

            The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

            • cloudWatchLogGroupName — (String)

              The name of the CloudWatch log group to send logs to.

              Note: The CloudWatch log group must already be created.
            • cloudWatchEncryptionEnabled — (Boolean)

              Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.

            • s3BucketName — (String)

              The name of the S3 bucket to send logs to.

              Note: The S3 bucket must already be created.
            • s3EncryptionEnabled — (Boolean)

              Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.

            • s3KeyPrefix — (String)

              An optional folder in the S3 bucket to place logs in.

        • managedStorageConfiguration — (map)

          The details of the managed storage configuration.

          • kmsKeyId — (String)

            Specify a Key Management Service key ID to encrypt the managed storage.

          • fargateEphemeralStorageKmsKeyId — (String)

            Specify the Key Management Service key ID for the Fargate ephemeral storage.

      • status — (String)

        The status of the cluster. The following are the possible states that are returned.

        ACTIVE

        The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

        PROVISIONING

        The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.

        DEPROVISIONING

        The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.

        FAILED

        The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.

        INACTIVE

        The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

      • registeredContainerInstancesCount — (Integer)

        The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

      • runningTasksCount — (Integer)

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

      • pendingTasksCount — (Integer)

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

      • activeServicesCount — (Integer)

        The number of services that are running on the cluster in an ACTIVE state. You can view these services with PListServices.

      • statistics — (Array<map>)

        Additional information about your clusters that are separated by launch type. They include the following:

        • runningEC2TasksCount

        • RunningFargateTasksCount

        • pendingEC2TasksCount

        • pendingFargateTasksCount

        • activeEC2ServiceCount

        • activeFargateServiceCount

        • drainingEC2ServiceCount

        • drainingFargateServiceCount

        • name — (String)

          The name of the key-value pair. For environment variables, this is the name of the environment variable.

        • value — (String)

          The value of the key-value pair. For environment variables, this is the value of the environment variable.

      • tags — (Array<map>)

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

        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.

        • key — (String)

          One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • value — (String)

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

      • settings — (Array<map>)

        The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off for a cluster.

        • name — (String)

          The name of the cluster setting. The value is containerInsights .

          Possible values include:
          • "containerInsights"
        • value — (String)

          The value to set for the cluster setting. The supported values are enabled and disabled.

          If you set name to containerInsights and value to enabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the containerInsights account setting is turned on. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

      • capacityProviders — (Array<String>)

        The capacity providers associated with the cluster.

      • defaultCapacityProviderStrategy — (Array<map>)

        The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

        • capacityProvider — required — (String)

          The short name of the capacity provider.

        • weight — (Integer)

          The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

          If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

          An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

        • base — (Integer)

          The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

      • attachments — (Array<map>)

        The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.

        • id — (String)

          The unique identifier for the attachment.

        • type — (String)

          The type of the attachment, such as ElasticNetworkInterface, Service Connect, and AmazonElasticBlockStorage.

        • status — (String)

          The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED.

        • details — (Array<map>)

          Details of the attachment.

          For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

          For Service Connect services, this includes portName, clientAliases, discoveryName, and ingressPortOverride.

          For Elastic Block Storage, this includes roleArn, deleteOnTermination, volumeName, volumeId, and statusReason (only when the attachment fails to create or attach).

          • name — (String)

            The name of the key-value pair. For environment variables, this is the name of the environment variable.

          • value — (String)

            The value of the key-value pair. For environment variables, this is the value of the environment variable.

      • attachmentsStatus — (String)

        The status of the capacity providers associated with the cluster. The following are the states that are returned.

        UPDATE_IN_PROGRESS

        The available capacity providers for the cluster are updating.

        UPDATE_COMPLETE

        The capacity providers have successfully updated.

        UPDATE_FAILED

        The capacity provider updates failed.

      • serviceConnectDefaults — (map)

        Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

        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.

        • namespace — (String)

          The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes the my-http-service service. The service must have a desired count and running count of 0 before you can delete it. */

 var params = {
  service: "my-http-service"
 };
 ecs.deleteService(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  service: 'STRING_VALUE', /* required */
  cluster: 'STRING_VALUE',
  force: true || false
};
ecs.deleteService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • cluster — (String)

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

  • service — (String)

    The name of the service to delete.

  • force — (Boolean)

    If true, allows you to delete a service even if it wasn't scaled down to zero tasks. It's only necessary to use this if the service uses the REPLICA scheduling strategy.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • service — (map)

      The full description of the deleted service.

      • serviceArn — (String)

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

      • serviceName — (String)

        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.

      • clusterArn — (String)

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

      • loadBalancers — (Array<map>)

        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.

        • targetGroupArn — (String)

          The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

          A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.

          For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

          For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

          If your service's task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

        • loadBalancerName — (String)

          The name of the load balancer to associate with the Amazon ECS service or task set.

          If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

        • containerName — (String)

          The name of the container (as it appears in a container definition) to associate with the load balancer.

          You need to specify the container name when configuring the target group for an Amazon ECS load balancer.

        • containerPort — (Integer)

          The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.

      • serviceRegistries — (Array<map>)

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

        • registryArn — (String)

          The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

        • port — (Integer)

          The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

        • containerName — (String)

          The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

        • containerPort — (Integer)

          The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

      • status — (String)

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

      • desiredCount — (Integer)

        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.

      • runningCount — (Integer)

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

      • pendingCount — (Integer)

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

      • launchType — (String)

        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.

        Possible values include:
        • "EC2"
        • "FARGATE"
        • "EXTERNAL"
      • capacityProviderStrategy — (Array<map>)

        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.

        • capacityProvider — required — (String)

          The short name of the capacity provider.

        • weight — (Integer)

          The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

          If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

          An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

        • base — (Integer)

          The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

      • platformVersion — (String)

        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.

      • platformFamily — (String)

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

      • taskDefinition — (String)

        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.

      • deploymentConfiguration — (map)

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

        • deploymentCircuitBreaker — (map)
          Note: The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

          The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide

          • enable — required — (Boolean)

            Determines whether to use the deployment circuit breaker logic for the service.

          • rollback — required — (Boolean)

            Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

        • maximumPercent — (Integer)

          If a service is using the rolling update (ECS) deployment type, the maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA service scheduler and has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default maximumPercent value for a service using the REPLICA service scheduler is 200%.

          If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

        • minimumHealthyPercent — (Integer)

          If a service is using the rolling update (ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.

          For services that do not use a load balancer, the following should be noted:

          • A service is considered healthy if all essential containers within the tasks in the service pass their health checks.

          • If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent total.

          • If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.

          For services that do use a load balancer, the following should be noted:

          • If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

          • If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

          The default value for a replica service for minimumHealthyPercent is 100%. The default minimumHealthyPercent value for a service using the DAEMON service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.

          The minimum number of healthy tasks during a deployment is the desiredCount multiplied by the minimumHealthyPercent/100, rounded up to the nearest integer value.

          If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

        • alarms — (map)

          Information about the CloudWatch alarms.

          • alarmNames — required — (Array<String>)

            One or more CloudWatch alarm names. Use a "," to separate the alarms.

          • enable — required — (Boolean)

            Determines whether to use the CloudWatch alarm option in the service deployment process.

          • rollback — required — (Boolean)

            Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

      • taskSets — (Array<map>)

        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.

        • id — (String)

          The ID of the task set.

        • taskSetArn — (String)

          The Amazon Resource Name (ARN) of the task set.

        • serviceArn — (String)

          The Amazon Resource Name (ARN) of the service the task set exists in.

        • clusterArn — (String)

          The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

        • startedBy — (String)

          The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.

        • externalId — (String)

          The external ID associated with the task set.

          If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.

          If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

        • status — (String)

          The status of the task set. The following describes each state.

          PRIMARY

          The task set is serving production traffic.

          ACTIVE

          The task set isn't serving production traffic.

          DRAINING

          The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.

        • taskDefinition — (String)

          The task definition that the task set is using.

        • computedDesiredCount — (Integer)

          The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

        • pendingCount — (Integer)

          The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it's restarted after being in the STOPPED state.

        • runningCount — (Integer)

          The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

        • createdAt — (Date)

          The Unix timestamp for the time when the task set was created.

        • updatedAt — (Date)

          The Unix timestamp for the time when the task set was last updated.

        • launchType — (String)

          The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

          Possible values include:
          • "EC2"
          • "FARGATE"
          • "EXTERNAL"
        • capacityProviderStrategy — (Array<map>)

          The capacity provider strategy that are associated with the task set.

          • capacityProvider — required — (String)

            The short name of the capacity provider.

          • weight — (Integer)

            The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

            If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

            An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

          • base — (Integer)

            The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

        • platformVersion — (String)

          The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

        • platformFamily — (String)

          The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.

          All tasks in the set must have the same value.

        • networkConfiguration — (map)

          The network configuration for the task set.

          • awsvpcConfiguration — (map)

            The VPC subnets and security groups that are associated with a task.

            Note: All specified subnets and security groups must be from the same VPC.
            • subnets — required — (Array<String>)

              The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per awsvpcConfiguration.

              Note: All specified subnets must be from the same VPC.
            • securityGroups — (Array<String>)

              The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per awsvpcConfiguration.

              Note: All specified security groups must be from the same VPC.
            • assignPublicIp — (String)

              Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
        • loadBalancers — (Array<map>)

          Details on a load balancer that are used with a task set.

          • targetGroupArn — (String)

            The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

            A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.

            For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

            For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

            If your service's task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

          • loadBalancerName — (String)

            The name of the load balancer to associate with the Amazon ECS service or task set.

            If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

          • containerName — (String)

            The name of the container (as it appears in a container definition) to associate with the load balancer.

            You need to specify the container name when configuring the target group for an Amazon ECS load balancer.

          • containerPort — (Integer)

            The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.

        • serviceRegistries — (Array<map>)

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

          • registryArn — (String)

            The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

          • port — (Integer)

            The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

          • containerName — (String)

            The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

          • containerPort — (Integer)

            The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

        • scale — (map)

          A floating-point percentage of your desired number of tasks to place and keep running in the task set.

          • value — (Float)

            The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.

          • unit — (String)

            The unit of measure for the scale value.

            Possible values include:
            • "PERCENT"
        • stabilityStatus — (String)

          The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in STEADY_STATE:

          • The task runningCount is equal to the computedDesiredCount.

          • The pendingCount is 0.

          • There are no tasks that are running on container instances in the DRAINING status.

          • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

          If any of those conditions aren't met, the stability status returns STABILIZING.

          Possible values include:
          • "STEADY_STATE"
          • "STABILIZING"
        • stabilityStatusAt — (Date)

          The Unix timestamp for the time when the task set stability status was retrieved.

        • tags — (Array<map>)

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

          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.

          • key — (String)

            One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

          • value — (String)

            The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

        • fargateEphemeralStorage — (map)

          The Fargate ephemeral storage settings for the task set.

          • kmsKeyId — (String)

            Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.

      • deployments — (Array<map>)

        The current state of deployments for the service.

        • id — (String)

          The ID of the deployment.

        • status — (String)

          The status of the deployment. The following describes each state.

          PRIMARY

          The most recent deployment of a service.

          ACTIVE

          A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

          INACTIVE

          A deployment that has been completely replaced.

        • taskDefinition — (String)

          The most recent task definition that was specified for the tasks in the service to use.

        • desiredCount — (Integer)

          The most recent desired count of tasks that was specified for the service to deploy or maintain.

        • pendingCount — (Integer)

          The number of tasks in the deployment that are in the PENDING status.

        • runningCount — (Integer)

          The number of tasks in the deployment that are in the RUNNING status.

        • failedTasks — (Integer)

          The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

          Note: Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
        • createdAt — (Date)

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

        • updatedAt — (Date)

          The Unix timestamp for the time when the service deployment was last updated.

        • capacityProviderStrategy — (Array<map>)

          The capacity provider strategy that the deployment is using.

          • capacityProvider — required — (String)

            The short name of the capacity provider.

          • weight — (Integer)

            The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

            If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

            An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

          • base — (Integer)

            The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

        • launchType — (String)

          The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

          Possible values include:
          • "EC2"
          • "FARGATE"
          • "EXTERNAL"
        • platformVersion — (String)

          The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. 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.

        • platformFamily — (String)

          The operating system that your tasks in the service, or tasks are running 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..

        • networkConfiguration — (map)

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

          • awsvpcConfiguration — (map)

            The VPC subnets and security groups that are associated with a task.

            Note: All specified subnets and security groups must be from the same VPC.
            • subnets — required — (Array<String>)

              The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per awsvpcConfiguration.

              Note: All specified subnets must be from the same VPC.
            • securityGroups — (Array<String>)

              The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per awsvpcConfiguration.

              Note: All specified security groups must be from the same VPC.
            • assignPublicIp — (String)

              Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
        • rolloutState — (String)
          Note: The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.

          The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

          Possible values include:
          • "COMPLETED"
          • "FAILED"
          • "IN_PROGRESS"
        • rolloutStateReason — (String)

          A description of the rollout state of a deployment.

        • serviceConnectConfiguration — (map)

          The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

          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.

          • enabled — required — (Boolean)

            Specifies whether to use Service Connect with this service.

          • namespace — (String)

            The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.

          • services — (Array<map>)

            The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

            This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

            An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

            • portName — required — (String)

              The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.

            • discoveryName — (String)

              The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

              If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

            • clientAliases — (Array<map>)

              The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.

              Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.

              Each name and port mapping must be unique within the namespace.

              For each ServiceConnectService, you must provide at least one clientAlias with one port.

              • port — required — (Integer)

                The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.

                To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

              • dnsName — (String)

                The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.

                If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

                To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

            • ingressPortOverride — (Integer)

              The port number for the Service Connect proxy to listen on.

              Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.

              In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.

            • timeout — (map)

              A reference to an object that represents the configured timeouts for Service Connect.

              • idleTimeoutSeconds — (Integer)

                The amount of time in seconds a connection will stay active while idle. A value of 0 can be set to disable idleTimeout.

                The idleTimeout default for HTTP/HTTP2/GRPC is 5 minutes.

                The idleTimeout default for TCP is 1 hour.

              • perRequestTimeoutSeconds — (Integer)

                The amount of time waiting for the upstream to respond with a complete response per request. A value of 0 can be set to disable perRequestTimeout. perRequestTimeout can only be set if Service Connect appProtocol isn't TCP. Only idleTimeout is allowed for TCP appProtocol.

            • tls — (map)

              A reference to an object that represents a Transport Layer Security (TLS) configuration.

              • issuerCertificateAuthority — required — (map)

                The signer certificate authority.

                • awsPcaAuthorityArn — (String)

                  The ARN of the Amazon Web Services Private Certificate Authority certificate.

              • kmsKey — (String)

                The Amazon Web Services Key Management Service key.

              • roleArn — (String)

                The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.

          • logConfiguration — (map)

            The log configuration for the container. This parameter maps to LogConfig in the docker conainer create command and the --log-driver option to docker run.

            By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition.

            Understand the following when specifying a log configuration for your containers.

            • Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.

              For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

              For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald,syslog, splunk, and awsfirelens.

            • This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.

            • For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

            • For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.

            • logDriver — required — (String)

              The log driver to use for the container.

              For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

              For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, syslog, splunk, and awsfirelens.

              For more information about using the awslogs log driver, see Send Amazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.

              For more information about using the awsfirelens log driver, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.

              Note: If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.
              Possible values include:
              • "json-file"
              • "syslog"
              • "journald"
              • "gelf"
              • "fluentd"
              • "awslogs"
              • "splunk"
              • "awsfirelens"
            • options — (map<String>)

              The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

            • secretOptions — (Array<map>)

              The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

              • name — required — (String)

                The name of the secret.

              • valueFrom — required — (String)

                The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

                For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.

                Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
        • serviceConnectResources — (Array<map>)

          The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

          • discoveryName — (String)

            The discovery name of this Service Connect resource.

            The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

            If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

          • discoveryArn — (String)

            The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.

        • volumeConfigurations — (Array<map>)

          The details of the volume that was configuredAtLaunch. You can configure different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

          • name — required — (String)

            The name of the volume. This value must match the volume name from the Volume object in the task definition.

          • managedEBSVolume — (map)

            The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.

            • encrypted — (Boolean)

              Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.

            • kmsKeyId — (String)

              The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference.

              Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.

            • volumeType — (String)

              The volume type. This parameter maps 1:1 with the VolumeType parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.

              The following are the supported volume types.

              • General Purpose SSD: gp2|gp3

              • Provisioned IOPS SSD: io1|io2

              • Throughput Optimized HDD: st1

              • Cold HDD: sc1

              • Magnetic: standard

                Note: The magnetic volume type is not supported on Fargate.
            • sizeInGiB — (Integer)

              The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.

              The following are the supported volume size values for each volume type.

              • gp2 and gp3: 1-16,384

              • io1 and io2: 4-16,384

              • st1 and sc1: 125-16,384

              • standard: 1-1,024

            • snapshotId — (String)

              The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.

            • iops — (Integer)

              The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

              The following are the supported values for each volume type.

              • gp3: 3,000 - 16,000 IOPS

              • io1: 100 - 64,000 IOPS

              • io2: 100 - 256,000 IOPS

              This parameter is required for io1 and io2 volume types. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for st1, sc1, or standard volume types.

              This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.

            • throughput — (Integer)

              The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.

              This parameter is only supported for the gp3 volume type.

            • tagSpecifications — (Array<map>)

              The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.

              • resourceType — required — (String)

                The type of volume resource.

                Possible values include:
                • "volume"
              • tags — (Array<map>)

                The tags applied to this Amazon EBS volume. AmazonECSCreated and AmazonECSManaged are reserved tags that can't be used.

                • key — (String)

                  One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

                • value — (String)

                  The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

              • propagateTags — (String)

                Determines whether to propagate the tags from the task definition to 
the Amazon EBS volume. Tags can only propagate to a SERVICE specified in 
ServiceVolumeConfiguration. If no value is specified, the tags aren't 
propagated.

                Possible values include:
                • "TASK_DEFINITION"
                • "SERVICE"
                • "NONE"
            • roleArn — required — (String)

              The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.

            • filesystemType — (String)

              The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.

              The available filesystem types are
 ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.

              Possible values include:
              • "ext3"
              • "ext4"
              • "xfs"
        • fargateEphemeralStorage — (map)

          The Fargate ephemeral storage settings for the deployment.

          • kmsKeyId — (String)

            Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.

      • roleArn — (String)

        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.

      • events — (Array<map>)

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

        • id — (String)

          The ID string for the event.

        • createdAt — (Date)

          The Unix timestamp for the time when the event was triggered.

        • message — (String)

          The event message.

      • createdAt — (Date)

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

      • placementConstraints — (Array<map>)

        The placement constraints for the tasks in the service.

        • type — (String)

          The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

          Possible values include:
          • "distinctInstance"
          • "memberOf"
        • expression — (String)

          A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

      • placementStrategy — (Array<map>)

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

        • type — (String)

          The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

          Possible values include:
          • "random"
          • "spread"
          • "binpack"
        • field — (String)

          The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

      • networkConfiguration — (map)

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

        • awsvpcConfiguration — (map)

          The VPC subnets and security groups that are associated with a task.

          Note: All specified subnets and security groups must be from the same VPC.
          • subnets — required — (Array<String>)

            The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per awsvpcConfiguration.

            Note: All specified subnets must be from the same VPC.
          • securityGroups — (Array<String>)

            The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per awsvpcConfiguration.

            Note: All specified security groups must be from the same VPC.
          • assignPublicIp — (String)

            Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
      • healthCheckGracePeriodSeconds — (Integer)

        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.

      • schedulingStrategy — (String)

        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.

          Note: Fargate tasks don't support the DAEMON scheduling strategy.
        Possible values include:
        • "REPLICA"
        • "DAEMON"
      • deploymentController — (map)

        The deployment controller type the service is using.

        • type — required — (String)

          The deployment controller type to use.

          There are three deployment controller types available:

          ECS

          The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.

          CODE_DEPLOY

          The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.

          EXTERNAL

          The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

          Possible values include:
          • "ECS"
          • "CODE_DEPLOY"
          • "EXTERNAL"
      • tags — (Array<map>)

        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.

        • key — (String)

          One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • value — (String)

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

      • createdBy — (String)

        The principal that created the service.

      • enableECSManagedTags — (Boolean)

        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.

      • propagateTags — (String)

        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.

        Possible values include:
        • "TASK_DEFINITION"
        • "SERVICE"
        • "NONE"
      • enableExecuteCommand — (Boolean)

        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.