java.lang.Object
- hudson.model.AbstractDescribableImpl<ECSTaskTemplate>
- - com.cloudbees.jenkins.plugins.amazonecs.ECSTaskTemplate

All Implemented Interfaces:

Describable<ECSTaskTemplate>, Serializable
```
public class ECSTaskTemplate
extends AbstractDescribableImpl<ECSTaskTemplate>
implements Serializable
```
Author:

Nicolas De Loof

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ECSTaskTemplate.CapacityProviderStrategyEntry`
`static class`	`ECSTaskTemplate.DescriptorImpl`
`static class`	`ECSTaskTemplate.EFSMountPointEntry`
`static class`	`ECSTaskTemplate.EnvironmentEntry`
`static class`	`ECSTaskTemplate.ExtraHostEntry`
`static class`	`ECSTaskTemplate.LogDriverOption`
`static class`	`ECSTaskTemplate.MountPointEntry`
`static class`	`ECSTaskTemplate.PlacementStrategyEntry`
`static class`	`ECSTaskTemplate.PortMappingEntry`
`static class`	`ECSTaskTemplate.Tag`
`static class`	`ECSTaskTemplate.UlimitEntry`

Constructor Summary

Constructors
Constructor	Description
ECSTaskTemplate(String templateName, String label, String agentContainerName, String taskDefinitionOverride, String dynamicTaskDefinitionOverride, String image, String repositoryCredentials, String launchType, String operatingSystemFamily, String cpuArchitecture, boolean defaultCapacityProvider, List<ECSTaskTemplate.CapacityProviderStrategyEntry> capacityProviderStrategies, String networkMode, String remoteFSRoot, boolean uniqueRemoteFSRoot, String platformVersion, int memory, int memoryReservation, int cpu, Integer ephemeralStorageSizeInGiB, String subnets, String securityGroups, boolean assignPublicIp, boolean privileged, String containerUser, String kernelCapabilities, List<ECSTaskTemplate.LogDriverOption> logDriverOptions, List<ECSTaskTemplate.Tag> tags, List<ECSTaskTemplate.EnvironmentEntry> environments, List<ECSTaskTemplate.ExtraHostEntry> extraHosts, List<ECSTaskTemplate.MountPointEntry> mountPoints, List<ECSTaskTemplate.EFSMountPointEntry> efsMountPoints, List<ECSTaskTemplate.PortMappingEntry> portMappings, List<ECSTaskTemplate.UlimitEntry> ulimits, String executionRole, List<ECSTaskTemplate.PlacementStrategyEntry> placementStrategies, String taskrole, String inheritFrom, int sharedMemorySize, boolean enableExecuteCommand)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`String`	`getAgentContainerName()`
`boolean`	`getAssignPublicIp()`
`List<ECSTaskTemplate.CapacityProviderStrategyEntry>`	`getCapacityProviderStrategies()`
`String`	`getContainerUser()`
`int`	`getCpu()`
`String`	`getCpuArchitecture()`
`boolean`	`getDefaultCapacityProvider()`
`String`	`getDisplayName()`
`String`	`getDnsSearchDomains()`
`String`	`getDynamicTaskDefinition()`
`List<ECSTaskTemplate.EFSMountPointEntry>`	`getEfsMountPoints()`
`String`	`getEntrypoint()`
`List<ECSTaskTemplate.EnvironmentEntry>`	`getEnvironments()`
`Integer`	`getEphemeralStorageSizeInGiB()`
`String`	`getExecutionRole()`
`List<ECSTaskTemplate.ExtraHostEntry>`	`getExtraHosts()`
`String`	`getImage()`
`String`	`getInheritFrom()`
`String`	`getJvmArgs()`
`String`	`getKernelCapabilities()`
`String`	`getLabel()`
`Set<LabelAtom>`	`getLabelSet()`
`String`	`getLaunchType()`
`String`	`getLogDriver()`
`List<ECSTaskTemplate.LogDriverOption>`	`getLogDriverOptions()`
`int`	`getMemory()`
`int`	`getMemoryConstraint()`
`int`	`getMemoryReservation()`
`List<ECSTaskTemplate.MountPointEntry>`	`getMountPoints()`
`String`	`getNetworkMode()`
`String`	`getOperatingSystemFamily()`
`List<ECSTaskTemplate.PlacementStrategyEntry>`	`getPlacementStrategies()`
`String`	`getPlatformVersion()`
`List<ECSTaskTemplate.PortMappingEntry>`	`getPortMappings()`
`boolean`	`getPrivileged()`
`String`	`getRemoteFSRoot()`
`String`	`getRepositoryCredentials()`
`String`	`getSecurityGroups()`
`int`	`getSharedMemorySize()`
`String`	`getSubnets()`
`List<ECSTaskTemplate.Tag>`	`getTags()`
`String`	`getTaskDefinitionOverride()`
`String`	`getTaskrole()`
`String`	`getTemplateName()`
`List<ECSTaskTemplate.UlimitEntry>`	`getUlimits()`
`boolean`	`getUniqueRemoteFSRoot()`
`int`	`hashCode()`
`boolean`	`isEC2()`
`boolean`	`isEnableExecuteCommand()`
`boolean`	`isFargate()`
`String`	`makeRemoteFSRoot(String name)`
`ECSTaskTemplate`	`merge(ECSTaskTemplate parent)`	This merge does not take an into consideration the child intentionally setting empty values for parameters like "entrypoint" - in fact it's not uncommon to override the entrypoint of a container and set it to blank so you can use your own entrypoint as part of the command.
`void`	`setContainerUser(String containerUser)`
`void`	`setDnsSearchDomains(String dnsSearchDomains)`
`void`	`setDynamicTaskDefinition(String dynamicTaskDefArn)`
`void`	`setEntrypoint(String entrypoint)`
`void`	`setExecutionRole(String executionRole)`
`void`	`setInheritFrom(String inheritFrom)`
`void`	`setJvmArgs(String jvmArgs)`
`void`	`setKernelCapabilities(String kernelCapabilities)`
`void`	`setLogDriver(String logDriver)`
`void`	`setRepositoryCredentials(String repositoryCredentials)`
`void`	`setSecurityGroups(String securityGroups)`
`void`	`setSubnets(String subnets)`
`void`	`setTaskrole(String taskRoleArn)`
`String`	`toString()`

Methods inherited from class hudson.model.AbstractDescribableImpl
getDescriptor

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ECSTaskTemplate

@DataBoundConstructor
public ECSTaskTemplate(String templateName,
                       @Nullable
                       String label,
                       @Nullable
                       String agentContainerName,
                       @Nullable
                       String taskDefinitionOverride,
                       @Nullable
                       String dynamicTaskDefinitionOverride,
                       String image,
                       @Nullable
                       String repositoryCredentials,
                       @Nullable
                       String launchType,
                       @Nullable
                       String operatingSystemFamily,
                       @Nullable
                       String cpuArchitecture,
                       boolean defaultCapacityProvider,
                       @Nullable
                       List<ECSTaskTemplate.CapacityProviderStrategyEntry> capacityProviderStrategies,
                       String networkMode,
                       @Nullable
                       String remoteFSRoot,
                       boolean uniqueRemoteFSRoot,
                       String platformVersion,
                       int memory,
                       int memoryReservation,
                       int cpu,
                       @Nullable
                       Integer ephemeralStorageSizeInGiB,
                       @Nullable
                       String subnets,
                       @Nullable
                       String securityGroups,
                       boolean assignPublicIp,
                       boolean privileged,
                       @Nullable
                       String containerUser,
                       @Nullable
                       String kernelCapabilities,
                       @Nullable
                       List<ECSTaskTemplate.LogDriverOption> logDriverOptions,
                       @Nullable
                       List<ECSTaskTemplate.Tag> tags,
                       @Nullable
                       List<ECSTaskTemplate.EnvironmentEntry> environments,
                       @Nullable
                       List<ECSTaskTemplate.ExtraHostEntry> extraHosts,
                       @Nullable
                       List<ECSTaskTemplate.MountPointEntry> mountPoints,
                       @Nullable
                       List<ECSTaskTemplate.EFSMountPointEntry> efsMountPoints,
                       @Nullable
                       List<ECSTaskTemplate.PortMappingEntry> portMappings,
                       @Nullable
                       List<ECSTaskTemplate.UlimitEntry> ulimits,
                       @Nullable
                       String executionRole,
                       @Nullable
                       List<ECSTaskTemplate.PlacementStrategyEntry> placementStrategies,
                       @Nullable
                       String taskrole,
                       @Nullable
                       String inheritFrom,
                       int sharedMemorySize,
                       boolean enableExecuteCommand)

Method Detail

getMemoryConstraint
```
public int getMemoryConstraint()
```

setDynamicTaskDefinition

@DataBoundSetter
public void setDynamicTaskDefinition(String dynamicTaskDefArn)

setTaskrole

@DataBoundSetter
public void setTaskrole(String taskRoleArn)

setExecutionRole

@DataBoundSetter
public void setExecutionRole(String executionRole)

setRepositoryCredentials

@DataBoundSetter
public void setRepositoryCredentials(String repositoryCredentials)

setEntrypoint

@DataBoundSetter
public void setEntrypoint(String entrypoint)

setJvmArgs

@DataBoundSetter
public void setJvmArgs(String jvmArgs)

setContainerUser

@DataBoundSetter
public void setContainerUser(String containerUser)

setKernelCapabilities

@DataBoundSetter
public void setKernelCapabilities(String kernelCapabilities)

setLogDriver

@DataBoundSetter
public void setLogDriver(String logDriver)

setInheritFrom

@DataBoundSetter
public void setInheritFrom(String inheritFrom)

setSubnets

@DataBoundSetter
public void setSubnets(String subnets)

setSecurityGroups

@DataBoundSetter
public void setSecurityGroups(String securityGroups)

setDnsSearchDomains

@DataBoundSetter
public void setDnsSearchDomains(String dnsSearchDomains)

isFargate
```
public boolean isFargate()
```

isEC2
```
public boolean isEC2()
```

getLabel
```
public String getLabel()
```

getAgentContainerName
```
public String getAgentContainerName()
```

getTaskDefinitionOverride

public String getTaskDefinitionOverride()

getDynamicTaskDefinition

public String getDynamicTaskDefinition()

getImage
```
public String getImage()
```

getRemoteFSRoot
```
public String getRemoteFSRoot()
```

makeRemoteFSRoot

public String makeRemoteFSRoot(@Nonnull
                               String name)

getUniqueRemoteFSRoot

public boolean getUniqueRemoteFSRoot()

getPlatformVersion
```
public String getPlatformVersion()
```

getMemory
```
public int getMemory()
```

getMemoryReservation
```
public int getMemoryReservation()
```

getCpu
```
public int getCpu()
```

getSharedMemorySize
```
public int getSharedMemorySize()
```

getEphemeralStorageSizeInGiB

public Integer getEphemeralStorageSizeInGiB()

getSubnets
```
public String getSubnets()
```

getSecurityGroups
```
public String getSecurityGroups()
```

getAssignPublicIp
```
public boolean getAssignPublicIp()
```

getDefaultCapacityProvider

public boolean getDefaultCapacityProvider()

getDnsSearchDomains
```
public String getDnsSearchDomains()
```

getEntrypoint
```
public String getEntrypoint()
```

getTaskrole
```
public String getTaskrole()
```

getExecutionRole
```
public String getExecutionRole()
```

getRepositoryCredentials

public String getRepositoryCredentials()

getJvmArgs
```
public String getJvmArgs()
```

getPrivileged
```
public boolean getPrivileged()
```

getContainerUser
```
public String getContainerUser()
```

getKernelCapabilities
```
public String getKernelCapabilities()
```

getLaunchType
```
public String getLaunchType()
```

getOperatingSystemFamily

public String getOperatingSystemFamily()

getCpuArchitecture
```
public String getCpuArchitecture()
```

getNetworkMode
```
public String getNetworkMode()
```

getLogDriver
```
public String getLogDriver()
```

getInheritFrom
```
public String getInheritFrom()
```

getTemplateName
```
public String getTemplateName()
```

isEnableExecuteCommand

public boolean isEnableExecuteCommand()

toString
```
public String toString()
```
Overrides:

toString in class Object

getLogDriverOptions

public List<ECSTaskTemplate.LogDriverOption> getLogDriverOptions()

getTags

public List<ECSTaskTemplate.Tag> getTags()

getEnvironments

public List<ECSTaskTemplate.EnvironmentEntry> getEnvironments()

getExtraHosts

public List<ECSTaskTemplate.ExtraHostEntry> getExtraHosts()

getPortMappings

public List<ECSTaskTemplate.PortMappingEntry> getPortMappings()

getUlimits

public List<ECSTaskTemplate.UlimitEntry> getUlimits()

getPlacementStrategies

public List<ECSTaskTemplate.PlacementStrategyEntry> getPlacementStrategies()

getCapacityProviderStrategies

public List<ECSTaskTemplate.CapacityProviderStrategyEntry> getCapacityProviderStrategies()

merge
```
public ECSTaskTemplate merge(ECSTaskTemplate parent)
```
This merge does not take an into consideration the child intentionally setting empty values for parameters like "entrypoint" - in fact it's not uncommon to override the entrypoint of a container and set it to blank so you can use your own entrypoint as part of the command. What's really needed is a "MergeStrategy
```
BinaryOperator<ECSTaskTemplate>
```
that's user selectable.
Parameters:

parent - inherit settings from

Returns:

a 'merged' template

getMountPoints

public List<ECSTaskTemplate.MountPointEntry> getMountPoints()

getEfsMountPoints

public List<ECSTaskTemplate.EFSMountPointEntry> getEfsMountPoints()

getLabelSet
```
public Set<LabelAtom> getLabelSet()
```

getDisplayName
```
public String getDisplayName()
```

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class ECSTaskTemplate

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class hudson.model.AbstractDescribableImpl

Methods inherited from class java.lang.Object

Constructor Detail

ECSTaskTemplate

Method Detail

getMemoryConstraint

setDynamicTaskDefinition

setTaskrole

setExecutionRole

setRepositoryCredentials

setEntrypoint

setJvmArgs

setContainerUser

setKernelCapabilities

setLogDriver

setInheritFrom

setSubnets

setSecurityGroups

setDnsSearchDomains

isFargate

isEC2

getLabel

getAgentContainerName

getTaskDefinitionOverride

getDynamicTaskDefinition

getImage

getRemoteFSRoot

makeRemoteFSRoot

getUniqueRemoteFSRoot

getPlatformVersion

getMemory

getMemoryReservation

getCpu

getSharedMemorySize

getEphemeralStorageSizeInGiB

getSubnets

getSecurityGroups

getAssignPublicIp

getDefaultCapacityProvider

getDnsSearchDomains

getEntrypoint

getTaskrole

getExecutionRole

getRepositoryCredentials

getJvmArgs

getPrivileged

getContainerUser

getKernelCapabilities

getLaunchType

getOperatingSystemFamily

getCpuArchitecture

getNetworkMode

getLogDriver

getInheritFrom

getTemplateName

isEnableExecuteCommand

toString

getLogDriverOptions

getTags

getEnvironments

getExtraHosts

getPortMappings

getUlimits

getPlacementStrategies

getCapacityProviderStrategies

merge

getMountPoints

getEfsMountPoints

getLabelSet

getDisplayName

equals

hashCode