AmazonCloudDriver (nextflow 19.09.0-egde API)

nextflow.cloud.aws.AmazonCloudDriver

All Implemented Interfaces and Traits:: CloudDriver

@groovy.util.logging.Slf4j
@groovy.transform.CompileStatic
@ServiceName('aws')
class AmazonCloudDriver
extends java.lang.Object

Implements the cloud driver of Amazon AWS

Authors:: Paolo Di Tommaso

Constructor Summary

Constructors
Constructor and description
`AmazonCloudDriver ()` Initialise the Amazon cloud driver with default (empty) parameters
`AmazonCloudDriver (java.util.Map config)` Initialise the Amazon cloud driver with the specified parameters
`protected AmazonCloudDriver (com.amazonaws.services.ec2.AmazonEC2Client client)` only for testing purpose -- do not use

Methods Summary

Methods
Type Params	Return Type	Name and description
	`CloudInstanceType`	`describeInstanceType(java.lang.String instanceType)` Describe an instance type by the given type
	`void`	`eachInstance(groovy.lang.Closure callback)` Iterate over the list of available EC2 instances
	`void`	`eachInstanceWithIds(java.util.List<java.lang.String> instanceIds, groovy.lang.Closure callback)` Iterate over the list of instances for the given instance IDs
	`void`	`eachInstanceWithTags(java.util.Map tags, groovy.lang.Closure callback)` Iterate over the list of instances for the given tags
	`void`	`eachSpotPrice(java.util.List<java.lang.String> instanceTypes, groovy.lang.Closure action)` Iterate over list of spot prices for the given instance types
	`protected java.lang.String`	`fetchIamRole()` Retrieve the current IAM role eventually define for a EC2 instance.
	`protected java.lang.String`	`fetchRegion()` Retrieve the AWS region from the EC2 instance metadata.
	`protected java.lang.String`	`getAccessKey()` @return The current set AWS access key
	`com.amazonaws.services.batch.AWSBatchClient`	`getBatchClient()` Gets or lazily creates an com.amazonaws.services.batch.AWSBatchClient instance given the current configuration parameter
	`com.amazonaws.services.ec2.AmazonEC2Client`	`getEc2Client()` Gets or lazily creates an com.amazonaws.services.ec2.AmazonEC2Client instance given the current configuration parameter
	`java.lang.String`	`getLocalInstanceId()` @return The current instance identified
	`java.lang.String`	`getLocalTerminationNotice()` Retrieve a termination notice for spot instance notifying the instance is going to be retired.
	`protected java.lang.String`	`getSecretKey()` @return The current set AWS secret key
	`protected java.lang.String`	`getUrl(java.lang.String path, int timeout = 150)` Fetch a remote URL resource text content
	`protected java.lang.String`	`getsessionToken()` @return The current set AWS session key
	`java.util.List<java.lang.String>`	`launchInstances(int instanceCount, LaunchConfig cfg)`
	`java.util.List<java.lang.String>`	`listPrivateIPs(java.lang.String clusterName)` Retrieve the private IPs of all nodes in the cluster with the specified name
	`void`	`tagInstances(java.util.Collection<java.lang.String> instanceIds, java.util.Map<java.lang.String, java.lang.String> tags)` Tag one or more instances with the specified key=value pairs
	`void`	`terminateInstances(java.util.Collection<java.lang.String> instanceIds)` Terminate one or more EC2 instances
	`void`	`validate(LaunchConfig config)` Validate the cloud configuration object
	`void`	`waitInstanceStatus(java.util.Collection<java.lang.String> instanceIds, CloudInstanceStatus status)` Wait for the specified instances reach the specified CloudInstanceStatus

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - AmazonCloudDriver()
    
    Initialise the Amazon cloud driver with default (empty) parameters
  - @groovy.transform.CompileDynamic AmazonCloudDriver(java.util.Map config)
    
    Initialise the Amazon cloud driver with the specified parameters
    Parameters:
    config - A map holding the driver parameters: - accessKey: the access key credentials - secretKey: the secret key credentials - region: the AWS region
  - @groovy.transform.CompileDynamic protected AmazonCloudDriver(com.amazonaws.services.ec2.AmazonEC2Client client)
    
    only for testing purpose -- do not use
- Method Detail
  - @groovy.transform.Memoized CloudInstanceType describeInstanceType(java.lang.String instanceType)
    
    Describe an instance type by the given type Note: it's declared as Memoized to avoid to make a remote API call for each invocation
    Parameters:
    instanceType - The instance type ID e.g. m3.2xlarge
    Returns:
    The CloudInstanceType instance for the given instance or null if no record is found for the given instance type
  - void eachInstance(@groovy.transform.stc.ClosureParams(value=SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)
    
    Iterate over the list of available EC2 instances
    Parameters:
    callback - A closure getting a single parameter of type CloudInstance, representing the action to be applied on each instance
    See Also:
    CloudInstance
  - void eachInstanceWithIds(java.util.List<java.lang.String> instanceIds, @groovy.transform.stc.ClosureParams(value=SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)
    
    Iterate over the list of instances for the given instance IDs
    Parameters:
    instanceIds - One or more instance IDs
    callback - A closure getting a single parameter of type CloudInstance describing the properties for the current instance
    See Also:
    CloudInstance
  - void eachInstanceWithTags(java.util.Map tags, @groovy.transform.stc.ClosureParams(value=SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)
    
    Iterate over the list of instances for the given tags
    Parameters:
    tags - One or more tag given as a java.util.Map object
    callback - A closure getting a single parameter of type CloudInstance describing the properties for the current instance
    See Also:
    CloudInstance
  - void eachSpotPrice(java.util.List<java.lang.String> instanceTypes, groovy.lang.Closure action)
    
    Iterate over list of spot prices for the given instance types
    Parameters:
    instanceTypes - A collection of instance types
    callback - A closure getting a single parameter of type CloudSpotPrice describing the instance properties and price for the actual instance type
  - protected java.lang.String fetchIamRole()
    
    Retrieve the current IAM role eventually define for a EC2 instance. See http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#instance-metadata-security-credentials
    Returns:
    The IAM role name associated to this instance or null if no role is defined or it's not a EC2 instance
  - protected java.lang.String fetchRegion()
    
    Retrieve the AWS region from the EC2 instance metadata. See http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
    Returns:
    The AWS region of the current EC2 instance eg. eu-west-1 or null if it's not an EC2 instance.
  - protected java.lang.String getAccessKey()
    
    Returns:
    The current set AWS access key
  - @groovy.transform.Memoized com.amazonaws.services.batch.AWSBatchClient getBatchClient()
    
    Gets or lazily creates an com.amazonaws.services.batch.AWSBatchClient instance given the current configuration parameter
    Returns:
    An com.amazonaws.services.batch.AWSBatchClient instance
  - com.amazonaws.services.ec2.AmazonEC2Client getEc2Client()
    
    Gets or lazily creates an com.amazonaws.services.ec2.AmazonEC2Client instance given the current configuration parameter
    Returns:
    An com.amazonaws.services.ec2.AmazonEC2Client instance
  - @java.lang.Override java.lang.String getLocalInstanceId()
    
    Returns:
    The current instance identified
  - @java.lang.Override java.lang.String getLocalTerminationNotice()
    
    Retrieve a termination notice for spot instance notifying the instance is going to be retired. https://aws.amazon.com/blogs/aws/new-ec2-spot-instance-termination-notices/ http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html
    Returns:
    The termination notice string as returned by the instance metadata
  - protected java.lang.String getSecretKey()
    
    Returns:
    The current set AWS secret key
  - protected java.lang.String getUrl(java.lang.String path, int timeout = 150)
    
    Fetch a remote URL resource text content
    Parameters:
    path - A valid http/https resource URL
    timeout - Max connection timeout in millis
    Returns:
    The resource URL content
  - protected java.lang.String getsessionToken()
    
    Returns:
    The current set AWS session key
  - @java.lang.Override java.util.List<java.lang.String> launchInstances(int instanceCount, LaunchConfig cfg)
  - @java.lang.Override java.util.List<java.lang.String> listPrivateIPs(java.lang.String clusterName)
    
    Retrieve the private IPs of all nodes in the cluster with the specified name
    Parameters:
    clusterName - The name of the cluster for which retrieve the list of IPs
    Returns:
    The list of node IPs in the specified cluster
  - @java.lang.Override void tagInstances(java.util.Collection<java.lang.String> instanceIds, java.util.Map<java.lang.String, java.lang.String> tags)
    
    Tag one or more instances with the specified key=value pairs
    Parameters:
    instanceIds - A list of instance IDs
    tags - A mpa of tags to be associated to the specified instances
  - void terminateInstances(java.util.Collection<java.lang.String> instanceIds)
    
    Terminate one or more EC2 instances
    Parameters:
    instanceIds - A list of instance IDs
  - void validate(LaunchConfig config)
    
    Validate the cloud configuration object
    Parameters:
    config - The LaunchConfig configuration object
  - @java.lang.Override void waitInstanceStatus(java.util.Collection<java.lang.String> instanceIds, CloudInstanceStatus status)
    
    Wait for the specified instances reach the specified CloudInstanceStatus
    Parameters:
    instanceIds - One or more EC2 instance IDs

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class AmazonCloudDriver

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

AmazonCloudDriver()

@groovy.transform.CompileDynamic AmazonCloudDriver(java.util.Map config)

@groovy.transform.CompileDynamic protected AmazonCloudDriver(com.amazonaws.services.ec2.AmazonEC2Client client)

Method Detail

@groovy.transform.Memoized CloudInstanceType describeInstanceType(java.lang.String instanceType)

void eachInstance(@groovy.transform.stc.ClosureParams(value=SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)

void eachInstanceWithIds(java.util.List<java.lang.String> instanceIds, @groovy.transform.stc.ClosureParams(value=SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)

void eachInstanceWithTags(java.util.Map tags, @groovy.transform.stc.ClosureParams(value=SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)

void eachSpotPrice(java.util.List<java.lang.String> instanceTypes, groovy.lang.Closure action)

protected java.lang.String fetchIamRole()

protected java.lang.String fetchRegion()

protected java.lang.String getAccessKey()

@groovy.transform.Memoized com.amazonaws.services.batch.AWSBatchClient getBatchClient()

com.amazonaws.services.ec2.AmazonEC2Client getEc2Client()

@java.lang.Override java.lang.String getLocalInstanceId()

@java.lang.Override java.lang.String getLocalTerminationNotice()

protected java.lang.String getSecretKey()

protected java.lang.String getUrl(java.lang.String path, int timeout = 150)

protected java.lang.String getsessionToken()

@java.lang.Override java.util.List<java.lang.String> launchInstances(int instanceCount, LaunchConfig cfg)

@java.lang.Override java.util.List<java.lang.String> listPrivateIPs(java.lang.String clusterName)

@java.lang.Override void tagInstances(java.util.Collection<java.lang.String> instanceIds, java.util.Map<java.lang.String, java.lang.String> tags)

void terminateInstances(java.util.Collection<java.lang.String> instanceIds)

void validate(LaunchConfig config)

@java.lang.Override void waitInstanceStatus(java.util.Collection<java.lang.String> instanceIds, CloudInstanceStatus status)