EC2 Component
Properties Methods Events Configuration Settings Errors
The EC2 Component provides an easy interface to Amazon's EC2 Web Services.
Syntax
nsoftware.InAmazon.Ec2
Remarks
EC2 allows you to create globally accessible cloud computing interfaces on Amazon's servers. Please refer to Amazon EC2 documentation for further details.
You will first need to sign up for the EC2 service and obtain the AccessKey and SecretKey from Amazon.
After obtaining an Access Key and Secret Key, you will be able to list all available Images on the EC2 servers by using ListImages. A user can also register and deregister their personally created images by using Register and Deregister.
Instances can be created from the available Images.
Instances can be controlled by using StartInstance, StopInstance, ListInstances, and RestartInstance.
The EC2 Component also allows a user to designate and control Elastic IP addresses using ListAddresses, AllocateAddress, DisassociateAddress, AssociateAddress, and ReleaseAddress.
Key management is supported as well using ListKeyPairs, CreateKeyPair, and DeleteKeyPair.
For further information on using the Amazon EC2 Web Services, please refer to the online documentation.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| AccessKey | The Access Key Id for the Amazon Web Services account. |
| AvailabilityZone | The Availability Zone within which to launch the instance. |
| Firewall | A set of properties related to firewall access. |
| Keys | The Keys to use while launching an instance from StartInstance . |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| Proxy | A set of properties related to proxy access. |
| SecretKey | The Secret Access Key for the Amazon Web Services account. |
| SecurityGroups | Security Groups to use while launching instances with StartInstance . |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| AllocateAddress | Acquires an elastic IP address for use with your account. |
| AssociateAddress | Associates an elastic IP address with an instance. |
| Config | Sets or retrieves a configuration setting . |
| CreateKeyPair | Creates a new key pair to use while launching Instances. |
| CreateSecurityGroup | Creates a new Security Group with the specified name and description. |
| DeleteKeyPair | Deletes a specified KeyPair. |
| DeleteSecurityGroup | Removes a Security Group. |
| Deregister | Removes an Image from the pool of available images to launch. |
| DisassociateAddress | Disassociates the elastic IP specified by PublicIp. |
| DoEvents | Processes events from the internal message queue. |
| GetConsoleOutput | Retrieves console output for the specified InstanceId. |
| GetXValue | Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . |
| Interrupt | Interrupt the current method. |
| ListAddresses | Describes all of the available EC2 addresses. |
| ListAvailabilityZones | Describes the EC2 Availability Zones for the current user. |
| ListImages | Lists all available Images. |
| ListInstances | Lists all of the running Instances of the specified user. |
| ListKeyPairs | Lists the KeyPairs available to the current user. |
| ListSecurityGroups | Returns information for all of the security groups of the current user. |
| Register | Registers an Image to be launched as an Instance. |
| ReleaseAddress | Releases an elastic IP address associated with your account. |
| Reset | Resets request-related properties. |
| RestartInstance | Restarts the Instance specified by InstanceId. |
| SendCustomRequest | Allows the sending of a custom request to an Amazon web service. |
| StartInstance | Start an instance of the specified ImageId. |
| StopInstance | Shutdown the instance specified by InstanceId. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Address | Lists each instance and the subsequent public IP linked to that specific instance. |
| AvailabilityZone | Lists all current Availability Zones. |
| Error | Information about errors during data delivery. |
| Image | Fired upon a successful call to ListImages . |
| Instance | Lists the information available for each running instance. |
| KeyPair | Fired upon a successful receipt of a KeyPair description. |
| SecurityGroup | Fired for each Security Group Description that is received. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| DryRun | Perform a dry run of a StartInstance call. |
| ImageIdList | A list of image Ids to return. |
| InstanceIdList | A list of instance Ids to return. |
| InstanceType | The InstanceType to use while starting an instance. |
| KernelId | The KernelId to use while starting an instance. |
| OwnerIdList | A list of Owner IDs to return images for. |
| RamdiskId | The RamdiskId to use while starting an instance. |
| Region | Defines the region to be used. |
| RunInstance | Controls whether to create or start an instance. |
| SecurityGroupIpRange | The IP Address range to use while creating a security group. |
| SecurityGroupPortRange | The port range to use while creating a security group. |
| SecurityGroupProtocol | The protocol to use while creating a security group. |
| TagCount | Total number of key/value combinations of a tag assigned to the resource. |
| TagKey[i] | The key of a tag assigned to the resource at index 'i'. |
| TagValue[i] | The value of a tag assigned to the resource at index 'i'. |
| TerminateInstance | Whether to terminate the instance or not when a StopInstance call is made. |
| UserData | The UserData to use while starting an instance. |
| APIVersion | Amazon's API version. |
| HTTPMethod | Specifies the HTTP method to use when sending a custom request. |
| SignCustomRequest | Tells the component to sign the outgoing request. |
| TransferredData | Returns the entire XML response received from Amazon. |
| URL | If set, the default URL will be overridden by this value. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |