Initializing help system before first use

Main functions of the AEC2 package

Topics covered in this chapter:

Public declarations

An AMI is represented by the EC2image record type described as follows: 

id:string
name:text
description:text    ! "Xpress for AEC2" for images created by aec2setup
location:text
snapshot:text
available:boolean
ispublic:boolean
architecture:string
owner:string
ownerid:string

A running (or recently terminated) instance is represented by the EC2instance record type publishing the following fields: 

image:string        ! image name
state:integer       ! AEC2_PENDING/AEC2_RUNNING/AEC2_SHUTTING_DOWN/
                    ! AEC2_STOPPED/AEC2_STOPPING/AEC2_TERMINATED
dns:text            ! public DNS name
key:text            ! key used for ssh connections
type:string         ! e.g. "t1.micro"
launchtime:datetime
ipaddr:text         ! public IP

The package also publishes the following global variables: 

aec2_image:string     ! image name
aec2_type:string      ! instance type (e.g. "t1.micro")
aec2_secgrp:string    ! security group for SSH sessions
aec2_connmode:string  ! connecion mode: "xprmsrv" or "ssh"
aec2_xsrvctx:string   ! xprmsrv context
aec2_xsrvpass:string  ! xprmsrv password
aec2_xsrvport:integer ! xprmsrv connection port

These variables are initialised when loading the configuration file using loadAEC2Config but may be modified directly after this routine has been called.

Procedures and functions

getAllInstances
Retrieve a list of Instances from AWS.
getConnString
Generate a connection string.
getConnStringSSH
Generate a connection string for an SSH link.
getConnStringXSRV
Generate a connection string for an xprmsrv server.
getImages
Retrieve a list of AMI from AWS.
loadAEC2Config
Load a configuration file and initialise the package.
runInstance
Start a new instance in EC2.
terminateInstance
Terminate the specified instance.
updateInstance
Update instance information.
waitInstanceReady
Wait for an instance to be ready.

Covered Topics
Parent Topic Amazon EC2 Module

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.