Package hudson.plugins.ec2

Class SlaveTemplate

java.lang.Object

hudson.plugins.ec2.SlaveTemplate

All Implemented Interfaces:

Describable<SlaveTemplate>

public class SlaveTemplate
extends Object
implements Describable<SlaveTemplate>

Template of EC2AbstractSlave to launch.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SlaveTemplate.DescriptorImpl
static class	SlaveTemplate.OnSaveListener
static class	SlaveTemplate.ProvisionOptions

Field Summary

Fields

Modifier and Type	Field	Description
String	ami
AMITypeData	amiType
boolean	associatePublicIp
boolean	connectBySSHProcess
ConnectionStrategy	connectionStrategy
boolean	connectUsingPublicIp	Deprecated.
String	currentSubnetId
String	customDeviceMapping
boolean	deleteRootOnTermination
String	description
EbsEncryptRootVolume	ebsEncryptRootVolume
boolean	ebsOptimized
HostKeyVerificationStrategyEnum	hostKeyVerificationStrategy
String	iamInstanceProfile
String	idleTerminationMinutes
String	initScript
int	instanceCap
String	javaPath
String	jvmopts
String	labels
int	launchTimeout
int	maxTotalUses
Node.Mode	mode
boolean	monitoring
int	nextSubnet
String	numExecutors
protected EC2Cloud	parent
String	remoteAdmin
String	remoteFS
String	rootCommandPrefix	Deprecated.
String	securityGroups
String	slaveCommandPrefix	Deprecated.
String	slaveCommandSuffix	Deprecated.
SpotConfiguration	spotConfig
String	sshPort	Deprecated.
boolean	stopOnTerminate
String	subnetId
boolean	t2Unlimited
Tenancy	tenancy
String	tmpDir
com.amazonaws.services.ec2.model.InstanceType	type
boolean	useDedicatedTenancy	Deprecated.
boolean	useEphemeralDevices
boolean	usePrivateDnsName	Deprecated.
String	userData
String	zone

Constructor Summary

Constructors

Constructor	Description
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, boolean usePrivateDnsName, String instanceCapStr, String iamInstanceProfile, boolean deleteRootOnTermination, boolean useEphemeralDevices, boolean useDedicatedTenancy, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping, boolean connectBySSHProcess, boolean connectUsingPublicIp)	Deprecated.
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, boolean usePrivateDnsName, String instanceCapStr, String iamInstanceProfile, boolean deleteRootOnTermination, boolean useEphemeralDevices, boolean useDedicatedTenancy, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping, boolean connectBySSHProcess, boolean connectUsingPublicIp, boolean monitoring, boolean t2Unlimited)	Deprecated.
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, boolean usePrivateDnsName, String instanceCapStr, String iamInstanceProfile, boolean useEphemeralDevices, boolean useDedicatedTenancy, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping)	Deprecated.
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, boolean usePrivateDnsName, String instanceCapStr, String iamInstanceProfile, boolean useEphemeralDevices, boolean useDedicatedTenancy, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping, boolean connectBySSHProcess)	Deprecated.
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, int minimumNumberOfInstances, int minimumNumberOfSpareInstances, String instanceCapStr, String iamInstanceProfile, boolean deleteRootOnTermination, boolean useEphemeralDevices, boolean useDedicatedTenancy, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping, boolean connectBySSHProcess, boolean monitoring, boolean t2Unlimited, ConnectionStrategy connectionStrategy, int maxTotalUses, List<? extends NodeProperty<?>> nodeProperties)	Deprecated.
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, int minimumNumberOfInstances, int minimumNumberOfSpareInstances, String instanceCapStr, String iamInstanceProfile, boolean deleteRootOnTermination, boolean useEphemeralDevices, boolean useDedicatedTenancy, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping, boolean connectBySSHProcess, boolean monitoring, boolean t2Unlimited, ConnectionStrategy connectionStrategy, int maxTotalUses, List<? extends NodeProperty<?>> nodeProperties, HostKeyVerificationStrategyEnum hostKeyVerificationStrategy)	Deprecated.
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, int minimumNumberOfInstances, int minimumNumberOfSpareInstances, String instanceCapStr, String iamInstanceProfile, boolean deleteRootOnTermination, boolean useEphemeralDevices, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping, boolean connectBySSHProcess, boolean monitoring, boolean t2Unlimited, ConnectionStrategy connectionStrategy, int maxTotalUses, List<? extends NodeProperty<?>> nodeProperties, HostKeyVerificationStrategyEnum hostKeyVerificationStrategy, Tenancy tenancy)	Deprecated.
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, int minimumNumberOfInstances, int minimumNumberOfSpareInstances, String instanceCapStr, String iamInstanceProfile, boolean deleteRootOnTermination, boolean useEphemeralDevices, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping, boolean connectBySSHProcess, boolean monitoring, boolean t2Unlimited, ConnectionStrategy connectionStrategy, int maxTotalUses, List<? extends NodeProperty<?>> nodeProperties, HostKeyVerificationStrategyEnum hostKeyVerificationStrategy, Tenancy tenancy, EbsEncryptRootVolume ebsEncryptRootVolume)	Deprecated.
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, int minimumNumberOfInstances, String instanceCapStr, String iamInstanceProfile, boolean deleteRootOnTermination, boolean useEphemeralDevices, boolean useDedicatedTenancy, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping, boolean connectBySSHProcess, boolean monitoring, boolean t2Unlimited, ConnectionStrategy connectionStrategy, int maxTotalUses)	Deprecated.
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, int minimumNumberOfInstances, String instanceCapStr, String iamInstanceProfile, boolean deleteRootOnTermination, boolean useEphemeralDevices, boolean useDedicatedTenancy, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping, boolean connectBySSHProcess, boolean monitoring, boolean t2Unlimited, ConnectionStrategy connectionStrategy, int maxTotalUses, List<? extends NodeProperty<?>> nodeProperties)	Deprecated.
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, String instanceCapStr, String iamInstanceProfile, boolean deleteRootOnTermination, boolean useEphemeralDevices, boolean useDedicatedTenancy, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping, boolean connectBySSHProcess, boolean monitoring, boolean t2Unlimited, ConnectionStrategy connectionStrategy, int maxTotalUses)	Deprecated.
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String javaPath, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, int minimumNumberOfInstances, int minimumNumberOfSpareInstances, String instanceCapStr, String iamInstanceProfile, boolean deleteRootOnTermination, boolean useEphemeralDevices, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping, boolean connectBySSHProcess, boolean monitoring, boolean t2Unlimited, ConnectionStrategy connectionStrategy, int maxTotalUses, List<? extends NodeProperty<?>> nodeProperties, HostKeyVerificationStrategyEnum hostKeyVerificationStrategy, Tenancy tenancy, EbsEncryptRootVolume ebsEncryptRootVolume, Boolean metadataSupported, Boolean metadataEndpointEnabled, Boolean metadataTokensRequired, Integer metadataHopsLimit)	Deprecated.
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String javaPath, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, int minimumNumberOfInstances, int minimumNumberOfSpareInstances, String instanceCapStr, String iamInstanceProfile, boolean deleteRootOnTermination, boolean useEphemeralDevices, String launchTimeoutStr, boolean associatePublicIp, String customDeviceMapping, boolean connectBySSHProcess, boolean monitoring, boolean t2Unlimited, ConnectionStrategy connectionStrategy, int maxTotalUses, List<? extends NodeProperty<?>> nodeProperties, HostKeyVerificationStrategyEnum hostKeyVerificationStrategy, Tenancy tenancy, EbsEncryptRootVolume ebsEncryptRootVolume, Boolean metadataEndpointEnabled, Boolean metadataTokensRequired, Integer metadataHopsLimit, Boolean metadataSupported)
SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS, String sshPort, com.amazonaws.services.ec2.model.InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript, String tmpDir, String userData, String numExecutors, String remoteAdmin, String rootCommandPrefix, String slaveCommandPrefix, String slaveCommandSuffix, String jvmopts, boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, boolean usePrivateDnsName, String instanceCapStr, String iamInstanceProfile, boolean useEphemeralDevices, String launchTimeoutStr)	Backward compatible constructor for reloading previous version data

Method Summary

Modifier and Type	Method	Description
EC2AbstractSlave	attach(String instanceId, TaskListener listener)	Provisions a new EC2 agent based on the currently running instance on EC2, instead of starting a new one.
String	chooseSubnetId()
String	chooseSubnetId(boolean rotateSubnet)
Secret	getAdminPassword()
String	getAmi()
List<EC2Filter>	getAmiFilters()
String	getAmiOwners()
AMITypeData	getAmiType()
String	getAmiUsers()
boolean	getAssociatePublicIp()
String	getCurrentSubnetId()
Descriptor<SlaveTemplate>	getDescriptor()
String	getDisplayName()
HostKeyVerificationStrategyEnum	getHostKeyVerificationStrategy()
String	getIamInstanceProfile()
String	getidleTerminationMinutes()
int	getInstanceCap()
String	getInstanceCapStr()
Set<LabelAtom>	getLabelSet()
String	getLabelString()
int	getLaunchTimeout()
String	getLaunchTimeoutStr()
int	getMaxTotalUses()
Boolean	getMetadataEndpointEnabled()
Integer	getMetadataHopsLimit()
Boolean	getMetadataSupported()
Boolean	getMetadataTokensRequired()
int	getMinimumNumberOfInstances()
MinimumNumberOfInstancesTimeRangeConfig	getMinimumNumberOfInstancesTimeRangeConfig()
int	getMinimumNumberOfSpareInstances()
Node.Mode	getMode()
DescribableList<NodeProperty<?>,NodePropertyDescriptor>	getNodeProperties()
int	getNumExecutors()
EC2Cloud	getParent()
String	getRemoteAdmin()
String	getRootCommandPrefix()
Set<String>	getSecurityGroupSet()
String	getSecurityGroupString()
String	getSlaveCommandPrefix()
String	getSlaveCommandSuffix()
String	getSlaveName(String instanceId)
int	getSpotBlockReservationDuration()
String	getSpotBlockReservationDurationStr()
String	getSpotMaxBidPrice()
int	getSshPort()
String	getSubnetId()
List<EC2Tag>	getTags()
Tenancy	getTenancyAttribute()
boolean	getUsePrivateDnsName()	Deprecated.
boolean	isAllowSelfSignedCertificate()
boolean	isConnectBySSHProcess()
boolean	isConnectUsingPublicIp()	Deprecated.
boolean	isMacAgent()
boolean	isUnixSlave()
boolean	isUseHTTPS()
boolean	isWindowsSlave()
protected EC2OndemandSlave	newOndemandSlave(com.amazonaws.services.ec2.model.Instance inst)
protected EC2SpotSlave	newSpotSlave(com.amazonaws.services.ec2.model.SpotInstanceRequest sir)
Set<String>	parseSecurityGroups()
List<EC2AbstractSlave>	provision(int number, EnumSet<SlaveTemplate.ProvisionOptions> provisionOptions)	Provisions a new EC2 agent or starts a previously stopped on-demand instance.
protected Object	readResolve()	Initializes data structure that we don't persist.
void	setAmi(String ami)
void	setAmiFilters(List<EC2Filter> amiFilters)
void	setAmiOwners(String amiOwners)
void	setAmiType(AMITypeData amiType)
void	setAmiUsers(String amiUsers)
void	setConnectUsingPublicIp(boolean connectUsingPublicIp)	Deprecated.
void	setHostKeyVerificationStrategy(HostKeyVerificationStrategyEnum hostKeyVerificationStrategy)
void	setMinimumNumberOfInstancesTimeRangeConfig(MinimumNumberOfInstancesTimeRangeConfig minimumNumberOfInstancesTimeRangeConfig)
void	setUsePrivateDnsName(boolean usePrivateDnsName)	Deprecated.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ami

public String ami

description

public final String description

zone

public final String zone

spotConfig

public final SpotConfiguration spotConfig

securityGroups

public final String securityGroups

remoteFS

public final String remoteFS

type

public final com.amazonaws.services.ec2.model.InstanceType type

ebsOptimized

public final boolean ebsOptimized

monitoring

public final boolean monitoring

t2Unlimited

public final boolean t2Unlimited

labels

public final String labels

mode

public final Node.Mode mode

initScript

public final String initScript

tmpDir

public final String tmpDir

userData

public final String userData

numExecutors

public final String numExecutors

remoteAdmin

public final String remoteAdmin

javaPath

public String javaPath

jvmopts

public final String jvmopts

subnetId

public final String subnetId

idleTerminationMinutes

public final String idleTerminationMinutes

iamInstanceProfile

public final String iamInstanceProfile

deleteRootOnTermination

public final boolean deleteRootOnTermination

useEphemeralDevices

public final boolean useEphemeralDevices

customDeviceMapping

public final String customDeviceMapping

instanceCap

public int instanceCap

stopOnTerminate

public final boolean stopOnTerminate

connectionStrategy

public ConnectionStrategy connectionStrategy

hostKeyVerificationStrategy

public HostKeyVerificationStrategyEnum hostKeyVerificationStrategy

associatePublicIp

public final boolean associatePublicIp

parent

protected transient EC2Cloud parent

amiType

public AMITypeData amiType

launchTimeout

public int launchTimeout

connectBySSHProcess

public boolean connectBySSHProcess

maxTotalUses

public int maxTotalUses

nextSubnet

public int nextSubnet

currentSubnetId

public String currentSubnetId

tenancy

public Tenancy tenancy

ebsEncryptRootVolume

public EbsEncryptRootVolume ebsEncryptRootVolume

sshPort

@Deprecated
public transient String sshPort

Deprecated.

rootCommandPrefix

@Deprecated
public transient String rootCommandPrefix

Deprecated.

slaveCommandPrefix

@Deprecated
public transient String slaveCommandPrefix

Deprecated.

slaveCommandSuffix

@Deprecated
public transient String slaveCommandSuffix

Deprecated.

usePrivateDnsName

@Deprecated
public boolean usePrivateDnsName

Deprecated.

connectUsingPublicIp

@Deprecated
public boolean connectUsingPublicIp

Deprecated.

useDedicatedTenancy

@Deprecated
public transient boolean useDedicatedTenancy

Deprecated.

Constructor Detail

SlaveTemplate

@DataBoundConstructor
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String javaPath,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     int minimumNumberOfInstances,
                     int minimumNumberOfSpareInstances,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean deleteRootOnTermination,
                     boolean useEphemeralDevices,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping,
                     boolean connectBySSHProcess,
                     boolean monitoring,
                     boolean t2Unlimited,
                     ConnectionStrategy connectionStrategy,
                     int maxTotalUses,
                     List<? extends NodeProperty<?>> nodeProperties,
                     HostKeyVerificationStrategyEnum hostKeyVerificationStrategy,
                     Tenancy tenancy,
                     EbsEncryptRootVolume ebsEncryptRootVolume,
                     Boolean metadataEndpointEnabled,
                     Boolean metadataTokensRequired,
                     Integer metadataHopsLimit,
                     Boolean metadataSupported)

SlaveTemplate

@Deprecated
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String javaPath,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     int minimumNumberOfInstances,
                     int minimumNumberOfSpareInstances,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean deleteRootOnTermination,
                     boolean useEphemeralDevices,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping,
                     boolean connectBySSHProcess,
                     boolean monitoring,
                     boolean t2Unlimited,
                     ConnectionStrategy connectionStrategy,
                     int maxTotalUses,
                     List<? extends NodeProperty<?>> nodeProperties,
                     HostKeyVerificationStrategyEnum hostKeyVerificationStrategy,
                     Tenancy tenancy,
                     EbsEncryptRootVolume ebsEncryptRootVolume,
                     Boolean metadataSupported,
                     Boolean metadataEndpointEnabled,
                     Boolean metadataTokensRequired,
                     Integer metadataHopsLimit)

Deprecated.

SlaveTemplate

@Deprecated
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     int minimumNumberOfInstances,
                     int minimumNumberOfSpareInstances,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean deleteRootOnTermination,
                     boolean useEphemeralDevices,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping,
                     boolean connectBySSHProcess,
                     boolean monitoring,
                     boolean t2Unlimited,
                     ConnectionStrategy connectionStrategy,
                     int maxTotalUses,
                     List<? extends NodeProperty<?>> nodeProperties,
                     HostKeyVerificationStrategyEnum hostKeyVerificationStrategy,
                     Tenancy tenancy,
                     EbsEncryptRootVolume ebsEncryptRootVolume)

Deprecated.

SlaveTemplate

@Deprecated
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     int minimumNumberOfInstances,
                     int minimumNumberOfSpareInstances,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean deleteRootOnTermination,
                     boolean useEphemeralDevices,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping,
                     boolean connectBySSHProcess,
                     boolean monitoring,
                     boolean t2Unlimited,
                     ConnectionStrategy connectionStrategy,
                     int maxTotalUses,
                     List<? extends NodeProperty<?>> nodeProperties,
                     HostKeyVerificationStrategyEnum hostKeyVerificationStrategy,
                     Tenancy tenancy)

Deprecated.

SlaveTemplate

@Deprecated
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     int minimumNumberOfInstances,
                     int minimumNumberOfSpareInstances,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean deleteRootOnTermination,
                     boolean useEphemeralDevices,
                     boolean useDedicatedTenancy,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping,
                     boolean connectBySSHProcess,
                     boolean monitoring,
                     boolean t2Unlimited,
                     ConnectionStrategy connectionStrategy,
                     int maxTotalUses,
                     List<? extends NodeProperty<?>> nodeProperties,
                     HostKeyVerificationStrategyEnum hostKeyVerificationStrategy)

Deprecated.

SlaveTemplate

@Deprecated
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     int minimumNumberOfInstances,
                     int minimumNumberOfSpareInstances,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean deleteRootOnTermination,
                     boolean useEphemeralDevices,
                     boolean useDedicatedTenancy,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping,
                     boolean connectBySSHProcess,
                     boolean monitoring,
                     boolean t2Unlimited,
                     ConnectionStrategy connectionStrategy,
                     int maxTotalUses,
                     List<? extends NodeProperty<?>> nodeProperties)

Deprecated.

SlaveTemplate

@Deprecated
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     int minimumNumberOfInstances,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean deleteRootOnTermination,
                     boolean useEphemeralDevices,
                     boolean useDedicatedTenancy,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping,
                     boolean connectBySSHProcess,
                     boolean monitoring,
                     boolean t2Unlimited,
                     ConnectionStrategy connectionStrategy,
                     int maxTotalUses,
                     List<? extends NodeProperty<?>> nodeProperties)

Deprecated.

SlaveTemplate

@Deprecated
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     int minimumNumberOfInstances,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean deleteRootOnTermination,
                     boolean useEphemeralDevices,
                     boolean useDedicatedTenancy,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping,
                     boolean connectBySSHProcess,
                     boolean monitoring,
                     boolean t2Unlimited,
                     ConnectionStrategy connectionStrategy,
                     int maxTotalUses)

Deprecated.

SlaveTemplate

@Deprecated
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean deleteRootOnTermination,
                     boolean useEphemeralDevices,
                     boolean useDedicatedTenancy,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping,
                     boolean connectBySSHProcess,
                     boolean monitoring,
                     boolean t2Unlimited,
                     ConnectionStrategy connectionStrategy,
                     int maxTotalUses)

Deprecated.

SlaveTemplate

@Deprecated
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     boolean usePrivateDnsName,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean deleteRootOnTermination,
                     boolean useEphemeralDevices,
                     boolean useDedicatedTenancy,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping,
                     boolean connectBySSHProcess,
                     boolean connectUsingPublicIp,
                     boolean monitoring,
                     boolean t2Unlimited)

Deprecated.

SlaveTemplate

@Deprecated
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     boolean usePrivateDnsName,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean deleteRootOnTermination,
                     boolean useEphemeralDevices,
                     boolean useDedicatedTenancy,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping,
                     boolean connectBySSHProcess,
                     boolean connectUsingPublicIp)

Deprecated.

SlaveTemplate

@Deprecated
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     boolean usePrivateDnsName,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean useEphemeralDevices,
                     boolean useDedicatedTenancy,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping,
                     boolean connectBySSHProcess)

Deprecated.

SlaveTemplate

@Deprecated
public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     AMITypeData amiType,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     boolean usePrivateDnsName,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean useEphemeralDevices,
                     boolean useDedicatedTenancy,
                     String launchTimeoutStr,
                     boolean associatePublicIp,
                     String customDeviceMapping)

Deprecated.

SlaveTemplate

public SlaveTemplate(String ami,
                     String zone,
                     SpotConfiguration spotConfig,
                     String securityGroups,
                     String remoteFS,
                     String sshPort,
                     com.amazonaws.services.ec2.model.InstanceType type,
                     boolean ebsOptimized,
                     String labelString,
                     Node.Mode mode,
                     String description,
                     String initScript,
                     String tmpDir,
                     String userData,
                     String numExecutors,
                     String remoteAdmin,
                     String rootCommandPrefix,
                     String slaveCommandPrefix,
                     String slaveCommandSuffix,
                     String jvmopts,
                     boolean stopOnTerminate,
                     String subnetId,
                     List<EC2Tag> tags,
                     String idleTerminationMinutes,
                     boolean usePrivateDnsName,
                     String instanceCapStr,
                     String iamInstanceProfile,
                     boolean useEphemeralDevices,
                     String launchTimeoutStr)

Backward compatible constructor for reloading previous version data

Method Detail

isConnectBySSHProcess

public boolean isConnectBySSHProcess()

getParent

public EC2Cloud getParent()

getLabelString

public String getLabelString()

getMode

public Node.Mode getMode()

getDisplayName

public String getDisplayName()

getSlaveName

public String getSlaveName(String instanceId)

getSecurityGroupString

public String getSecurityGroupString()

getSecurityGroupSet

public Set<String> getSecurityGroupSet()

parseSecurityGroups

public Set<String> parseSecurityGroups()

getNumExecutors

public int getNumExecutors()

getSshPort

public int getSshPort()

getRemoteAdmin

public String getRemoteAdmin()

getRootCommandPrefix

public String getRootCommandPrefix()

getSlaveCommandPrefix

public String getSlaveCommandPrefix()

getSlaveCommandSuffix

public String getSlaveCommandSuffix()

chooseSubnetId

public String chooseSubnetId()

chooseSubnetId

public String chooseSubnetId(boolean rotateSubnet)

getSubnetId

public String getSubnetId()

getCurrentSubnetId

public String getCurrentSubnetId()

getAssociatePublicIp

public boolean getAssociatePublicIp()

setConnectUsingPublicIp

@Deprecated
@DataBoundSetter
public void setConnectUsingPublicIp(boolean connectUsingPublicIp)

Deprecated.

setUsePrivateDnsName

@Deprecated
@DataBoundSetter
public void setUsePrivateDnsName(boolean usePrivateDnsName)

Deprecated.

getUsePrivateDnsName

@Deprecated
public boolean getUsePrivateDnsName()

Deprecated.

isConnectUsingPublicIp

@Deprecated
public boolean isConnectUsingPublicIp()

Deprecated.

getTags

public List<EC2Tag> getTags()

getidleTerminationMinutes

public String getidleTerminationMinutes()

getLabelSet

public Set<LabelAtom> getLabelSet()

getAmi

public String getAmi()

setAmi

public void setAmi(String ami)

getAmiType

public AMITypeData getAmiType()

setAmiType

public void setAmiType(AMITypeData amiType)

getMinimumNumberOfInstances

public int getMinimumNumberOfInstances()

getMinimumNumberOfSpareInstances

public int getMinimumNumberOfSpareInstances()

getMinimumNumberOfInstancesTimeRangeConfig

public MinimumNumberOfInstancesTimeRangeConfig getMinimumNumberOfInstancesTimeRangeConfig()

setMinimumNumberOfInstancesTimeRangeConfig

@DataBoundSetter
public void setMinimumNumberOfInstancesTimeRangeConfig(MinimumNumberOfInstancesTimeRangeConfig minimumNumberOfInstancesTimeRangeConfig)

getInstanceCap

public int getInstanceCap()

getSpotBlockReservationDuration

public int getSpotBlockReservationDuration()

getSpotBlockReservationDurationStr

public String getSpotBlockReservationDurationStr()

getInstanceCapStr

public String getInstanceCapStr()

getSpotMaxBidPrice

public String getSpotMaxBidPrice()

getIamInstanceProfile

public String getIamInstanceProfile()

setHostKeyVerificationStrategy

@DataBoundSetter
public void setHostKeyVerificationStrategy(HostKeyVerificationStrategyEnum hostKeyVerificationStrategy)

getHostKeyVerificationStrategy

@NonNull
public HostKeyVerificationStrategyEnum getHostKeyVerificationStrategy()

getAmiOwners

@CheckForNull
public String getAmiOwners()

setAmiOwners

@DataBoundSetter
public void setAmiOwners(String amiOwners)

getAmiUsers

@CheckForNull
public String getAmiUsers()

setAmiUsers

@DataBoundSetter
public void setAmiUsers(String amiUsers)

getAmiFilters

@CheckForNull
public List<EC2Filter> getAmiFilters()

setAmiFilters

@DataBoundSetter
public void setAmiFilters(List<EC2Filter> amiFilters)

toString

public String toString()

Overrides:

toString in class Object

getMaxTotalUses

public int getMaxTotalUses()

getMetadataSupported

public Boolean getMetadataSupported()

getMetadataEndpointEnabled

public Boolean getMetadataEndpointEnabled()

getMetadataTokensRequired

public Boolean getMetadataTokensRequired()

getMetadataHopsLimit

public Integer getMetadataHopsLimit()

getTenancyAttribute

public Tenancy getTenancyAttribute()

getNodeProperties

public DescribableList<NodeProperty<?>,NodePropertyDescriptor> getNodeProperties()

provision

@NonNull
public List<EC2AbstractSlave> provision(int number,
                                        EnumSet<SlaveTemplate.ProvisionOptions> provisionOptions)
                                 throws com.amazonaws.AmazonClientException,
                                        IOException

Provisions a new EC2 agent or starts a previously stopped on-demand instance.

Returns:

always non-null. This needs to be then added to Jenkins.addNode(Node).

Throws:

com.amazonaws.AmazonClientException

IOException

newOndemandSlave

protected EC2OndemandSlave newOndemandSlave(com.amazonaws.services.ec2.model.Instance inst)
                                     throws Descriptor.FormException,
                                            IOException

Throws:

Descriptor.FormException

IOException

newSpotSlave

protected EC2SpotSlave newSpotSlave(com.amazonaws.services.ec2.model.SpotInstanceRequest sir)
                             throws Descriptor.FormException,
                                    IOException

Throws:

Descriptor.FormException

IOException

attach

public EC2AbstractSlave attach(String instanceId,
                               TaskListener listener)
                        throws com.amazonaws.AmazonClientException,
                               IOException

Provisions a new EC2 agent based on the currently running instance on EC2, instead of starting a new one.

Throws:

com.amazonaws.AmazonClientException

IOException

readResolve

protected Object readResolve()

Initializes data structure that we don't persist.

getDescriptor

public Descriptor<SlaveTemplate> getDescriptor()

Specified by:

getDescriptor in interface Describable<SlaveTemplate>

getLaunchTimeout

public int getLaunchTimeout()

getLaunchTimeoutStr

public String getLaunchTimeoutStr()

isWindowsSlave

public boolean isWindowsSlave()

isUnixSlave

public boolean isUnixSlave()

isMacAgent

public boolean isMacAgent()

getAdminPassword

public Secret getAdminPassword()

isUseHTTPS

public boolean isUseHTTPS()

isAllowSelfSignedCertificate

public boolean isAllowSelfSignedCertificate()