The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Amazon Elastic Container Service plugin

ecsTaskTemplate: Define a task template to use in the AWS ECS plugin

  • label
    • Type: String
  • name
    • Type: String
  • assignPublicIp (optional)
    • Type: boolean
  • cloud (optional)
    • Type: String
  • containerUser (optional)
    • Type: String
  • cpu (optional)
    • Type: int
  • environments (optional)
      Array/List
      Nested Object
    • name
      • Type: String
    • value
      • Type: String
  • executionRole (optional)
    • Type: String
  • extraHosts (optional)
      Array/List
      Nested Object
    • ipAddress
      • Type: String
    • hostname
      • Type: String
  • image (optional)
    • Type: String
  • inheritFrom (optional)

    You can pre-configure a task template in the system settings. Configure the label of this template to inherit from here.

    • Type: String
  • launchType (optional)
    • Type: String
  • logDriver (optional)
    • Type: String
  • logDriverOptions (optional)
      Array/List
      Nested Object
    • name
      • Type: String
    • value
      • Type: String
  • memory (optional)
    • Type: int
  • memoryReservation (optional)
    • Type: int
  • mountPoints (optional)
      Array/List
      Nested Object
    • name
      • Type: String
    • sourcePath
      • Type: String
    • containerPath
      • Type: String
    • readOnly
      • Type: boolean
  • networkMode (optional)
    • Type: String
  • overrides (optional)
      Array/List
    • Type: String
  • placementStrategies (optional)
      Array/List
      Nested Object
    • type
      • Type: String
    • field
      • Type: String
  • portMappings (optional)
      Array/List
      Nested Object
    • containerPort
      The port number on the container to bind to the host port.
      • Type: int
    • hostPort

      The port number on the host instance to map to the container port.

      If no host port is provided (or it is set to 0), the container will receive a port in the ephemeral port range.

      Reserved ports: 22 (SSH), 2375-2376 (Docker), and 51678 (ECS container agent)

      • Type: int
    • protocol
      The protocol used for the port mapping.
      • Type: String
  • privileged (optional)
    • Type: boolean
  • remoteFSRoot (optional)
    • Type: String
  • repositoryCredentials (optional)
    • Type: String
  • securityGroups (optional)
    • Type: String
  • sharedMemorySize (optional)
    • Type: int
  • subnets (optional)
    • Type: String
  • taskDefinitionOverride (optional)
    • Type: String
  • taskrole (optional)
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.