EC2 Plugin Reference
The XL Deploy EC2 plugin enables XL Deploy to provision Amazon Web Services Elastic Compute Cloud (EC2) instances.
This document contains information that is specific to this version of the EC2 plugin. For information about plugin features, refer to Introduction to the EC2 plugin. For general information about provisioning, refer to Provisioning through XL Deploy.
Requirements
- XL Deploy 5.5.0 or later
- User credentials for accessing Amazon Web Services Elastic Compute Cloud (EC2)
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| aws.ec2.InstanceSpec | Specification for an AWS EC2 instance |
Deployeds
| CI | Description |
|---|---|
| aws.ec2.Instance | AWS EC2 instance |
Containers
| CI | Description |
|---|---|
| aws.ec2.Cloud | AWS EC2 account |
Other Configuration Items
| CI | Description |
|---|---|
| aws.ec2.Cloud | AWS EC2 account |
| aws.ec2.Instance | AWS EC2 instance |
| aws.ec2.InstanceSpec | Specification for an AWS EC2 instance |
Configuration Item Details
aws.ec2.Cloud
| Type Hierarchy | upm.Provider >> udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Container, udm.ConfigurationItem, udm.Taggable |
AWS EC2 account.
| Public Properties | ||
|---|---|---|
|
|
|
accessSecret
:
STRING
|
|
The access secret to use when connecting to AWS EC2.
|
||
|
|
|
accesskey
:
STRING
|
|
The access key to use when connecting to AWS EC2.
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
aws.ec2.Instance
| Type Hierarchy | upm.Provisioned >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
AWS EC2 instance.
| Parent | ||
|---|---|---|
|
|
|
provider
:
CI<upm.Provider>
|
|
The provider on which this provisioned runs.
|
| Children | ||
|---|---|---|
|
|
|
provisioners
:
LIST_OF_CI<upm.AppliedProvisioner>
|
|
A list of provisioners associated with the instance.
|
| Public Properties | ||
|---|---|---|
|
|
|
instanceBootRetryCount
:
INTEGER
= 5
|
|
Number of retries to check if instance is fully booted.
|
||
|
|
|
instanceType
:
STRING
= m1.small
|
|
The instance type that you specify determines the hardware of the host computer used for your instance.
|
||
|
|
|
keyName
:
STRING
= default
|
|
The name of the key pair, if the instance was launched with an associated key pair.
|
||
|
|
|
ordinal
:
INTEGER
= 0
|
|
The index of the cardinality amount created provisioneds.
|
||
|
|
|
region
:
STRING
= eu-west-1
|
|
AWS region to use.
|
||
|
|
|
securityGroup
:
STRING
= default
|
|
AWS security group to use.
|
||
|
|
|
amiId
:
STRING
|
|
ID of the AMI to use. If an ID is not provided, the name of the CI will be used.
|
||
|
|
|
boundConfigurationItems
:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
instanceId
:
STRING
|
|
ID of the AWS instance.
|
||
|
|
|
provisionable
:
CI<upm.Provisionable>
|
|
The provisionable from which this provisioned is derived.
|
||
|
|
|
publicHostname
:
STRING
|
|
Public host name of the instance.
|
||
|
|
|
publicIp
:
STRING
|
|
Public IP address of the instance.
|
aws.ec2.InstanceSpec
| Type Hierarchy | upm.Provisionable >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
Specification for an AWS EC2 instance.
| Children | ||
|---|---|---|
|
|
|
provisioners
:
LIST_OF_CI<upm.Provisioner>
|
|
A list of provisioners associated with the instance.
|
| Public Properties | ||
|---|---|---|
|
|
|
amiId
:
STRING
|
|
ID of the AMI to use. If an ID is not provided, the name of the CI will be used. (string)
|
||
|
|
|
boundTemplates
:
SET_OF_CI<upm.Template>
|
|
The set of CI templates.
|
||
|
|
|
cardinality
:
STRING
= 1
|
|
Number of instances to launch.
|
||
|
|
|
instanceBootRetryCount
:
STRING
= 5
|
|
Number of retries to check if instance is fully booted. (integer) default(5)
|
||
|
|
|
instanceId
:
STRING
|
|
ID of the AWS instance. (string)
|
||
|
|
|
instanceType
:
STRING
= m1.small
|
|
The instance type that you specify determines the hardware of the host computer used for your instance. (string) default(m1.small)
|
||
|
|
|
keyName
:
STRING
= default
|
|
The name of the key pair, if the instance was launched with an associated key pair. (string) default(default)
|
||
|
|
|
publicHostname
:
STRING
|
|
Public host name of the instance. (string)
|
||
|
|
|
publicIp
:
STRING
|
|
Public IP address of the instance. (string)
|
||
|
|
|
region
:
STRING
= eu-west-1
|
|
AWS region to use. (string) default(eu-west-1)
|
||
|
|
|
securityGroup
:
STRING
= default
|
|
AWS security group to use. (string) default(default)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|