Serialized Form (Amazon Elastic Container Service (ECS) / Fargate plugin 1.49 API)

Package com.cloudbees.jenkins.plugins.amazonecs
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSLauncher.RetryableLaunchFailure extends Exception implements Serializable
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSSlave extends AbstractCloudSlave implements Serializable
  
  serialVersionUID:
  
  -6324547877157811307L
  - Serialization Methods
    - readObject
      
      private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException
      
      Throws:
      
      IOException
      
      ClassNotFoundException
    - writeObject
      
      private void writeObject(ObjectOutputStream stream) throws IOException
      
      Throws:
      
      IOException
  - Serialized Fields
    - cloud
      
      ECSCloud cloud
    - clusterArn
      
      String clusterArn
      
      AWS Resource Name (ARN) of the ECS Cluster.
    - survivable
      
      boolean survivable
    - taskArn
      
      String taskArn
      
      AWS Resource Name (ARN) of the ECS Task.
    - taskDefinitonArn
      
      String taskDefinitonArn
      
      AWS Resource Name (ARN) of the ECS Task Definition.
    - template
      
      ECSTaskTemplate template
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate extends AbstractDescribableImpl<ECSTaskTemplate> implements Serializable
  
  serialVersionUID:
  
  -426721853953018205L
  - Serialized Fields
    - agentContainerName
      
      String agentContainerName
    - assignPublicIp
      
      boolean assignPublicIp
      
      Assign a public Ip to instance on awsvpc network when using Fargate
      
      See Also:
      
      AwsVpcConfiguration.setAssignPublicIp(String)
    - capacityProviderStrategies
      
      List<ECSTaskTemplate.CapacityProviderStrategyEntry> capacityProviderStrategies
    - containerUser
      
      String containerUser
      
      User for container
    - cpu
      
      int cpu
      
      The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount.
      
      See Also:
      
      ContainerDefinition.withCpu(Integer)
    - cpuArchitecture
      
      String cpuArchitecture
      
      Task CPU architecture type
    - defaultCapacityProvider
      
      boolean defaultCapacityProvider
      
      Use default capacity provider will omit launch types and capacity strategies
    - dnsSearchDomains
      
      String dnsSearchDomains
      
      Space delimited list of Docker dns search domains
      
      See Also:
      
      ContainerDefinition.withDnsSearchDomains(Collection)
    - dynamicTaskDefinitionOverride
      
      String dynamicTaskDefinitionOverride
      
      ARN of the task definition created for a dynamic agent
    - efsMountPoints
      
      List<ECSTaskTemplate.EFSMountPointEntry> efsMountPoints
      
      Container mount points connecting to EFS
    - enableExecuteCommand
      
      boolean enableExecuteCommand
      
      Enable command execution during runtime (comparable to a `docker exec ...`). Cf. https://aws.amazon.com/blogs/containers/new-using-amazon-ecs-exec-access-your-containers-fargate-ec2/
    - entrypoint
      
      String entrypoint
      
      Space delimited list of Docker entry points
      
      See Also:
      
      ContainerDefinition.withEntryPoint(String...)
    - environments
      
      List<ECSTaskTemplate.EnvironmentEntry> environments
    - ephemeralStorageSizeInGiB
      
      Integer ephemeralStorageSizeInGiB
      
      The ephemeral storage settings to use for tasks run with the task definition.
      
      See Also:
      
      TaskDefinition.withEphemeralStorage(com.amazonaws.services.ecs.model.EphemeralStorage)
    - executionRole
      
      String executionRole
      
      ARN of the IAM role to use for the agent ECS task
      
      See Also:
      
      RegisterTaskDefinitionRequest.withExecutionRoleArn(String)
    - extraHosts
      
      List<ECSTaskTemplate.ExtraHostEntry> extraHosts
    - image
      
      String image
      
      Docker image
      
      See Also:
      
      ContainerDefinition.withImage(String)
    - inheritFrom
      
      String inheritFrom
    - jvmArgs
      
      String jvmArgs
      
      JVM arguments to start slave.jar
    - kernelCapabilities
      
      String kernelCapabilities
      
      List of kernel capabilities to be added
    - label
      
      String label
      
      White-space separated list of Node labels.
      
      See Also:
      
      Label
    - launchType
      
      String launchType
      
      Task launch type
    - logDriver
      
      String logDriver
      
      The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. Valid log drivers are displayed in the LogConfiguration data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version" The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance 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 EC2 Container Service Developer Guide.
    - logDriverOptions
      
      List<ECSTaskTemplate.LogDriverOption> logDriverOptions
    - memory
      
      int memory
      
      The number of MiB of memory reserved for the Docker container. If your container attempts to exceed the memory allocated here, the container is killed by ECS.
      
      See Also:
      
      ContainerDefinition.withMemory(Integer)
    - memoryReservation
      
      int memoryReservation
      
      The soft limit (in MiB) of memory to reserve for the container. When system memory is under contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first.
      
      See Also:
      
      ContainerDefinition.withMemoryReservation(Integer)
    - mountPoints
      
      List<ECSTaskTemplate.MountPointEntry> mountPoints
      
      Container mount points, imported from volumes
    - networkMode
      
      String networkMode
      
      Task network mode
    - operatingSystemFamily
      
      String operatingSystemFamily
      
      Task operating system family type
    - placementStrategies
      
      List<ECSTaskTemplate.PlacementStrategyEntry> placementStrategies
    - platformVersion
      
      String platformVersion
      
      Task launch type platform version
    - portMappings
      
      List<ECSTaskTemplate.PortMappingEntry> portMappings
    - privileged
      
      boolean privileged
      
      Indicates whether the container should run in privileged mode
    - remoteFSRoot
      
      String remoteFSRoot
      
      Agent remote FS
    - repositoryCredentials
      
      String repositoryCredentials
      
      ARN of the Secrets Manager to use for the agent ECS task
      
      See Also:
      
      ContainerDefinition.withRepositoryCredentials(RepositoryCredentials)
    - securityGroups
      
      String securityGroups
      
      Security groups to be assigned on the awsvpc network when using Fargate
      
      See Also:
      
      AwsVpcConfiguration.setSecurityGroups(Collection)
    - sharedMemorySize
      
      int sharedMemorySize
      
      Sets the size of Share Memory (in MiB) using the --shm-size option for the container. A container instance has 64mb /dev/shm size by default.
      
      See Also:
      
      LinuxParameters.withSharedMemorySize(Integer)
    - subnets
      
      String subnets
      
      Subnets to be assigned on the awsvpc network when using Fargate
      
      See Also:
      
      AwsVpcConfiguration.setSubnets(Collection)
    - tags
      
      List<ECSTaskTemplate.Tag> tags
    - taskDefinitionOverride
      
      String taskDefinitionOverride
      
      Task Definition Override to use, instead of a Jenkins-managed Task definition. May be a family name or an ARN.
    - taskrole
      
      String taskrole
      
      ARN of the IAM role to use for the agent ECS task
      
      See Also:
      
      RegisterTaskDefinitionRequest.withTaskRoleArn(String)
    - templateName
      
      String templateName
      
      Template Name
    - ulimits
      
      List<ECSTaskTemplate.UlimitEntry> ulimits
    - uniqueRemoteFSRoot
      
      boolean uniqueRemoteFSRoot
      
      Indicates whether to append a unique agent ID (the agent name) at the end of the remoteFSRoot path.
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.CapacityProviderStrategyEntry extends AbstractDescribableImpl<ECSTaskTemplate.CapacityProviderStrategyEntry> implements Serializable
  - Serialized Fields
    - base
      
      int base
    - provider
      
      String provider
    - weight
      
      int weight
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.EFSMountPointEntry extends AbstractDescribableImpl<ECSTaskTemplate.EFSMountPointEntry> implements Serializable
  
  serialVersionUID:
  
  -7894407420920480113L
  - Serialized Fields
    - accessPointId
      
      String accessPointId
    - containerPath
      
      String containerPath
    - fileSystemId
      
      String fileSystemId
    - iam
      
      Boolean iam
    - name
      
      String name
    - readOnly
      
      Boolean readOnly
    - rootDirectory
      
      String rootDirectory
    - transitEncryption
      
      Boolean transitEncryption
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.EnvironmentEntry extends AbstractDescribableImpl<ECSTaskTemplate.EnvironmentEntry> implements Serializable
  
  serialVersionUID:
  
  4195862080979262875L
  - Serialized Fields
    - name
      
      String name
    - value
      
      String value
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.ExtraHostEntry extends AbstractDescribableImpl<ECSTaskTemplate.ExtraHostEntry> implements Serializable
  
  serialVersionUID:
  
  -23978859661031633L
  - Serialized Fields
    - hostname
      
      String hostname
    - ipAddress
      
      String ipAddress
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.LogDriverOption extends AbstractDescribableImpl<ECSTaskTemplate.LogDriverOption> implements Serializable
  
  serialVersionUID:
  
  8585792353105873086L
  - Serialized Fields
    - name
      
      String name
    - value
      
      String value
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.MountPointEntry extends AbstractDescribableImpl<ECSTaskTemplate.MountPointEntry> implements Serializable
  
  serialVersionUID:
  
  -5363412950753423854L
  - Serialized Fields
    - containerPath
      
      String containerPath
    - name
      
      String name
    - readOnly
      
      Boolean readOnly
    - sourcePath
      
      String sourcePath
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.PlacementStrategyEntry extends AbstractDescribableImpl<ECSTaskTemplate.PlacementStrategyEntry> implements Serializable
  - Serialized Fields
    - field
      
      String field
    - type
      
      String type
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.PortMappingEntry extends AbstractDescribableImpl<ECSTaskTemplate.PortMappingEntry> implements Serializable
  
  serialVersionUID:
  
  8223725139080497839L
  - Serialized Fields
    - containerPort
      
      Integer containerPort
    - hostPort
      
      Integer hostPort
    - protocol
      
      String protocol
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.Tag extends AbstractDescribableImpl<ECSTaskTemplate.Tag> implements Serializable
  
  serialVersionUID:
  
  4357423231051873086L
  - Serialized Fields
    - name
      
      String name
    - value
      
      String value
- Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.UlimitEntry extends AbstractDescribableImpl<ECSTaskTemplate.UlimitEntry> implements Serializable
  
  serialVersionUID:
  
  8223725139080497838L
  - Serialized Fields
    - hardLimit
      
      Integer hardLimit
    - softLimit
      
      Integer softLimit
    - ulimitName
      
      String ulimitName

Package com.cloudbees.jenkins.plugins.amazonecs.pipeline

Class com.cloudbees.jenkins.plugins.amazonecs.pipeline.ECSDeclarativeAgent extends org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent<ECSDeclarativeAgent> implements Serializable

serialVersionUID:: 1L

Serialized Fields

agentContainerName
```
String agentContainerName
```
assignPublicIp
```
boolean assignPublicIp
```
cloud
```
String cloud
```
containerUser
```
String containerUser
```
cpu
```
int cpu
```

efsMountPoints

List<ECSTaskTemplate.EFSMountPointEntry> efsMountPoints

environments

List<ECSTaskTemplate.EnvironmentEntry> environments

ephemeralStorageSizeInGiB
```
Integer ephemeralStorageSizeInGiB
```
executionRole
```
String executionRole
```

extraHosts

List<ECSTaskTemplate.ExtraHostEntry> extraHosts

image
```
String image
```
inheritFrom
```
String inheritFrom
```
kernelCapabilities
```
String kernelCapabilities
```
label
```
String label
```
launchType
```
String launchType
```
logDriver
```
String logDriver
```

logDriverOptions

List<ECSTaskTemplate.LogDriverOption> logDriverOptions

memory
```
int memory
```
memoryReservation
```
int memoryReservation
```

mountPoints

List<ECSTaskTemplate.MountPointEntry> mountPoints

overrides
```
ArrayList<String> overrides
```

placementStrategies

List<ECSTaskTemplate.PlacementStrategyEntry> placementStrategies

platformVersion
```
String platformVersion
```

portMappings

List<ECSTaskTemplate.PortMappingEntry> portMappings

privileged
```
boolean privileged
```
remoteFSRoot
```
String remoteFSRoot
```
securityGroups
```
String securityGroups
```
sharedMemorySize
```
int sharedMemorySize
```
subnets
```
String subnets
```
tags
```
List<ECSTaskTemplate.Tag> tags
```
taskDefinitionOverride
```
String taskDefinitionOverride
```
taskrole
```
String taskrole
```

ulimits

List<ECSTaskTemplate.UlimitEntry> ulimits

uniqueRemoteFSRoot
```
boolean uniqueRemoteFSRoot
```

Class com.cloudbees.jenkins.plugins.amazonecs.pipeline.ECSTaskTemplateStep extends org.jenkinsci.plugins.workflow.steps.Step implements Serializable

serialVersionUID:: 1L

Serialized Fields

agentContainerName
```
String agentContainerName
```
assignPublicIp
```
boolean assignPublicIp
```

capacityProviderStrategies

List<ECSTaskTemplate.CapacityProviderStrategyEntry> capacityProviderStrategies

cloud
```
String cloud
```
containerUser
```
String containerUser
```
cpu
```
int cpu
```
cpuArchitecture
```
String cpuArchitecture
```
DEFAULT_CLOUD
```
String DEFAULT_CLOUD
```
defaultCapacityProvider
```
boolean defaultCapacityProvider
```

efsMountPoints

List<ECSTaskTemplate.EFSMountPointEntry> efsMountPoints

enableExecuteCommand
```
boolean enableExecuteCommand
```

environments

List<ECSTaskTemplate.EnvironmentEntry> environments

ephemeralStorageSizeInGiB
```
Integer ephemeralStorageSizeInGiB
```
executionRole
```
String executionRole
```

extraHosts

List<ECSTaskTemplate.ExtraHostEntry> extraHosts

image
```
String image
```
inheritFrom
```
String inheritFrom
```
kernelCapabilities
```
String kernelCapabilities
```
label
```
String label
```
launchType
```
String launchType
```
logDriver
```
String logDriver
```

logDriverOptions

List<ECSTaskTemplate.LogDriverOption> logDriverOptions

memory
```
int memory
```
memoryReservation
```
int memoryReservation
```

mountPoints

List<ECSTaskTemplate.MountPointEntry> mountPoints

name
```
String name
```
networkMode
```
String networkMode
```
operatingSystemFamily
```
String operatingSystemFamily
```
overrides
```
List<String> overrides
```

placementStrategies

List<ECSTaskTemplate.PlacementStrategyEntry> placementStrategies

platformVersion
```
String platformVersion
```

portMappings

List<ECSTaskTemplate.PortMappingEntry> portMappings

privileged
```
boolean privileged
```
remoteFSRoot
```
String remoteFSRoot
```
repositoryCredentials
```
String repositoryCredentials
```
securityGroups
```
String securityGroups
```
sharedMemorySize
```
int sharedMemorySize
```
subnets
```
String subnets
```
tags
```
List<ECSTaskTemplate.Tag> tags
```
taskDefinitionOverride
```
String taskDefinitionOverride
```
taskrole
```
String taskrole
```

ulimits

List<ECSTaskTemplate.UlimitEntry> ulimits

uniqueRemoteFSRoot
```
boolean uniqueRemoteFSRoot
```

Class com.cloudbees.jenkins.plugins.amazonecs.pipeline.ECSTaskTemplateStepExecution extends org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl implements Serializable

serialVersionUID:

1L
- Serialized Fields
  - cloudName
```
String cloudName
```
  - cloudSupplier
```
SerializableSupplier<Jenkins.CloudList> cloudSupplier
```
  - newTemplate
```
ECSTaskTemplate newTemplate
```

Serialized Form

Package com.cloudbees.jenkins.plugins.amazonecs

Class com.cloudbees.jenkins.plugins.amazonecs.ECSLauncher.RetryableLaunchFailure extends Exception implements Serializable

Class com.cloudbees.jenkins.plugins.amazonecs.ECSSlave extends AbstractCloudSlave implements Serializable

Serialization Methods

readObject

writeObject

Serialized Fields

cloud

clusterArn

survivable

taskArn

taskDefinitonArn

template

Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate extends AbstractDescribableImpl<ECSTaskTemplate> implements Serializable

Serialized Fields

agentContainerName

assignPublicIp

capacityProviderStrategies

containerUser

cpu

cpuArchitecture

defaultCapacityProvider

dnsSearchDomains

dynamicTaskDefinitionOverride

efsMountPoints

enableExecuteCommand

entrypoint

environments

ephemeralStorageSizeInGiB

executionRole

extraHosts

image

inheritFrom

jvmArgs

kernelCapabilities

label

launchType

logDriver

logDriverOptions

memory

memoryReservation

mountPoints

networkMode

operatingSystemFamily

placementStrategies

platformVersion

portMappings

privileged

remoteFSRoot

repositoryCredentials

securityGroups

sharedMemorySize

subnets

tags

taskDefinitionOverride

taskrole

templateName

ulimits

uniqueRemoteFSRoot

Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.CapacityProviderStrategyEntry extends AbstractDescribableImpl<ECSTaskTemplate.CapacityProviderStrategyEntry> implements Serializable

Serialized Fields

base

provider

weight

Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.EFSMountPointEntry extends AbstractDescribableImpl<ECSTaskTemplate.EFSMountPointEntry> implements Serializable

Serialized Fields

accessPointId

containerPath

fileSystemId

iam

name

readOnly

rootDirectory

transitEncryption

Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.EnvironmentEntry extends AbstractDescribableImpl<ECSTaskTemplate.EnvironmentEntry> implements Serializable

Serialized Fields

name

value

Class com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate.ExtraHostEntry extends AbstractDescribableImpl<ECSTaskTemplate.ExtraHostEntry> implements Serializable