Package hudson.plugins.ec2

Class EC2Cloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.slaves.Cloud

hudson.plugins.ec2.EC2Cloud

All Implemented Interfaces:

ExtensionPoint, Describable<Cloud>, ModelObject, SearchableModelObject, SearchItem, AccessControlled, ModelObjectWithContextMenu

Direct Known Subclasses:

AmazonEC2Cloud

public class EC2Cloud
extends Cloud

Hudson's view of EC2.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EC2Cloud.DescriptorImpl
static class	EC2Cloud.EC2ConnectionUpdater

Nested classes/interfaces inherited from class hudson.slaves.Cloud

Cloud.CloudState

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_EC2_HOST
static final String	EC2_REQUEST_EXPIRED_ERROR_CODE
static final String	EC2_SLAVE_TYPE_DEMAND
static final String	EC2_SLAVE_TYPE_SPOT
static final String	SSH_PRIVATE_KEY_FILEPATH

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Modifier	Constructor	Description
	EC2Cloud(String name, boolean useInstanceProfileForCredentials, String credentialsId, String region, String privateKey, String sshKeysCredentialsId, String instanceCapStr, List<? extends SlaveTemplate> templates, String roleArn, String roleSessionName)
	EC2Cloud(String name, boolean useInstanceProfileForCredentials, String credentialsId, String region, String privateKey, String instanceCapStr, List<? extends SlaveTemplate> templates, String roleArn, String roleSessionName)	Deprecated.
protected	EC2Cloud(String id, boolean useInstanceProfileForCredentials, String credentialsId, String privateKey, String instanceCapStr, List<? extends SlaveTemplate> templates, String roleArn, String roleSessionName)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addTemplate(SlaveTemplate newTemplate)
boolean	canProvision(Label label)
static URL	checkEndPoint(String url)
software.amazon.awssdk.services.ec2.Ec2Client	connect()	Connects to EC2 and returns Ec2Client, which can then be used to communicate with EC2.
static software.amazon.awssdk.core.client.config.ClientOverrideConfiguration	createClientOverrideConfiguration()
protected software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	createCredentialsProvider()
static software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	createCredentialsProvider(boolean useInstanceProfileForCredentials, String credentialsId)
static software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	createCredentialsProvider(boolean useInstanceProfileForCredentials, String credentialsId, String roleArn, String roleSessionName, String region)
void	doAttach(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, String id)	Debug command to attach to a running instance.
org.kohsuke.stapler.HttpResponse	doProvision(String template)
String	getAltEC2Endpoint()
String	getCloudName()	Deprecated. Use public field "name" instead.
String	getCredentialsId()
static software.amazon.awssdk.http.SdkHttpClient	getHttpClient()
int	getInstanceCap()
String	getInstanceCapStr()
KeyPair	getKeyPair()	Gets the KeyPairInfo used for the launch.
String	getName()
EC2PrivateKey	getPrivateKey()	Deprecated.
String	getRegion()
String	getRoleArn()
String	getRoleSessionName()
static String	getSlaveTypeTagValue(String slaveType, String templateDescription)
String	getSshKeysCredentialsId()
SlaveTemplate	getTemplate(Label label)	Deprecated.
SlaveTemplate	getTemplate(String template)
List<SlaveTemplate>	getTemplates()
Collection<SlaveTemplate>	getTemplates(Label label)	Gets list of SlaveTemplate that matches Label.
boolean	isCleanUpOrphanedNodes()
boolean	isNoDelayProvisioning()
boolean	isUseInstanceProfileForCredentials()
static void	log(Logger logger, Level level, TaskListener listener, String message)
static void	log(Logger logger, Level level, TaskListener listener, String message, Throwable exception)
static URI	parseEndpoint(String input)
static software.amazon.awssdk.regions.Region	parseRegion(String input)
Collection<NodeProvisioner.PlannedNode>	provision(Label label, int excessWorkload)
void	provision(SlaveTemplate t, int number)
protected Object	readResolve()
EC2PrivateKey	resolvePrivateKey()
void	setAltEC2Endpoint(String altEC2Endpoint)
void	setCleanUpOrphanedNodes(boolean cleanUpOrphanedNodes)
void	setNoDelayProvisioning(boolean noDelayProvisioning)
void	updateTemplate(SlaveTemplate newTemplate, String oldTemplateDescription)

Methods inherited from class hudson.slaves.Cloud

all, canProvision, doConfigSubmit, doDoDelete, getACL, getDescriptor, getDisplayName, getIcon, getIconAltText, getIconClassName, getSearchUrl, getUrl, provision, reconfigure, reconfigure, registerPermissions

Methods inherited from class hudson.model.Actionable

addAction, addOrReplaceAction, doContextMenu, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, getDynamic, getDynamic, removeAction, removeActions, replaceAction, replaceActions

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Field Details

DEFAULT_EC2_HOST

public static final String DEFAULT_EC2_HOST

See Also:

• Constant Field Values

EC2_SLAVE_TYPE_SPOT

public static final String EC2_SLAVE_TYPE_SPOT

See Also:

• Constant Field Values

EC2_SLAVE_TYPE_DEMAND

public static final String EC2_SLAVE_TYPE_DEMAND

See Also:

• Constant Field Values

EC2_REQUEST_EXPIRED_ERROR_CODE

public static final String EC2_REQUEST_EXPIRED_ERROR_CODE

See Also:

• Constant Field Values

SSH_PRIVATE_KEY_FILEPATH

public static final String SSH_PRIVATE_KEY_FILEPATH

Constructor Details

EC2Cloud

@DataBoundConstructor
public EC2Cloud(String name,
 boolean useInstanceProfileForCredentials,
 String credentialsId,
 String region,
 String privateKey,
 String sshKeysCredentialsId,
 String instanceCapStr,
 List<? extends SlaveTemplate> templates,
 String roleArn,
 String roleSessionName)

EC2Cloud

@Deprecated
public EC2Cloud(String name,
 boolean useInstanceProfileForCredentials,
 String credentialsId,
 String region,
 String privateKey,
 String instanceCapStr,
 List<? extends SlaveTemplate> templates,
 String roleArn,
 String roleSessionName)

Deprecated.

EC2Cloud

@Deprecated
protected EC2Cloud(String id,
 boolean useInstanceProfileForCredentials,
 String credentialsId,
 String privateKey,
 String instanceCapStr,
 List<? extends SlaveTemplate> templates,
 String roleArn,
 String roleSessionName)

Deprecated.

Method Details

resolvePrivateKey

@CheckForNull
public EC2PrivateKey resolvePrivateKey()

getCloudName

@Deprecated
public String getCloudName()

Deprecated.

Use public field "name" instead.

getName

public String getName()

getRegion

public String getRegion()

parseRegion

@CheckForNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static software.amazon.awssdk.regions.Region parseRegion(@CheckForNull
 String input)

parseEndpoint

@CheckForNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static URI parseEndpoint(@CheckForNull
 String input)

isNoDelayProvisioning

public boolean isNoDelayProvisioning()

setNoDelayProvisioning

@DataBoundSetter
public void setNoDelayProvisioning(boolean noDelayProvisioning)

isCleanUpOrphanedNodes

public boolean isCleanUpOrphanedNodes()

setCleanUpOrphanedNodes

@DataBoundSetter
public void setCleanUpOrphanedNodes(boolean cleanUpOrphanedNodes)

getAltEC2Endpoint

public String getAltEC2Endpoint()

setAltEC2Endpoint

@DataBoundSetter
public void setAltEC2Endpoint(String altEC2Endpoint)

addTemplate

public void addTemplate(SlaveTemplate newTemplate)
                 throws Exception

Throws:

Exception

updateTemplate

public void updateTemplate(SlaveTemplate newTemplate,
 String oldTemplateDescription)
                    throws Exception

Throws:

Exception

readResolve

protected Object readResolve()

isUseInstanceProfileForCredentials

public boolean isUseInstanceProfileForCredentials()

getRoleArn

public String getRoleArn()

getRoleSessionName

public String getRoleSessionName()

getCredentialsId

public String getCredentialsId()

getSshKeysCredentialsId

@CheckForNull
public String getSshKeysCredentialsId()

getPrivateKey

@Deprecated
public EC2PrivateKey getPrivateKey()

Deprecated.

getInstanceCapStr

public String getInstanceCapStr()

getInstanceCap

public int getInstanceCap()

getTemplates

public List<SlaveTemplate> getTemplates()

getTemplate

@CheckForNull
public SlaveTemplate getTemplate(String template)

getTemplate

@Deprecated
public SlaveTemplate getTemplate(Label label)

Deprecated.

Gets SlaveTemplate that has the matching Label.

getTemplates

public Collection<SlaveTemplate> getTemplates(Label label)

Gets list of SlaveTemplate that matches Label.

getKeyPair

@CheckForNull
public KeyPair getKeyPair()
                   throws software.amazon.awssdk.core.exception.SdkException,
IOException

Gets the KeyPairInfo used for the launch.

Throws:

software.amazon.awssdk.core.exception.SdkException

IOException

doAttach

public void doAttach(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @QueryParameter
 String id)
              throws jakarta.servlet.ServletException,
IOException,
software.amazon.awssdk.core.exception.SdkException

Debug command to attach to a running instance.

Throws:

jakarta.servlet.ServletException

IOException

software.amazon.awssdk.core.exception.SdkException

doProvision

public org.kohsuke.stapler.HttpResponse doProvision(@QueryParameter
 String template)
                                             throws jakarta.servlet.ServletException,
IOException

Throws:

jakarta.servlet.ServletException

IOException

provision

public Collection<NodeProvisioner.PlannedNode> provision(Label label,
 int excessWorkload)

Overrides:

provision in class Cloud

provision

public void provision(SlaveTemplate t,
 int number)

canProvision

public boolean canProvision(Label label)

Overrides:

canProvision in class Cloud

createCredentialsProvider

protected software.amazon.awssdk.auth.credentials.AwsCredentialsProvider createCredentialsProvider()

getSlaveTypeTagValue

public static String getSlaveTypeTagValue(String slaveType,
 String templateDescription)

createCredentialsProvider

public static software.amazon.awssdk.auth.credentials.AwsCredentialsProvider createCredentialsProvider(boolean useInstanceProfileForCredentials,
 String credentialsId)

createCredentialsProvider

public static software.amazon.awssdk.auth.credentials.AwsCredentialsProvider createCredentialsProvider(boolean useInstanceProfileForCredentials,
 String credentialsId,
 String roleArn,
 String roleSessionName,
 String region)

connect

public software.amazon.awssdk.services.ec2.Ec2Client connect()
                                                      throws software.amazon.awssdk.core.exception.SdkException

Connects to EC2 and returns Ec2Client, which can then be used to communicate with EC2.

Throws:

software.amazon.awssdk.core.exception.SdkException

getHttpClient

public static software.amazon.awssdk.http.SdkHttpClient getHttpClient()

createClientOverrideConfiguration

public static software.amazon.awssdk.core.client.config.ClientOverrideConfiguration createClientOverrideConfiguration()

checkEndPoint

public static URL checkEndPoint(String url)
                         throws FormValidation

Throws:

FormValidation

log

public static void log(Logger logger,
 Level level,
 TaskListener listener,
 String message)

log

public static void log(Logger logger,
 Level level,
 TaskListener listener,
 String message,
 Throwable exception)