Cloud.AWS.EC2.Instance
Request schema for provisioning of an AWS machine resource
{
"account": "string",
"activeDirectory": {
"finalRelativeDN": "string",
"relativeDN": "string",
"securityGroup": "string"
},
"address": "string",
"attachedDisks": [
{
"source": "string"
}
],
"autoScaleConfiguration": {
"desiredCapacity": 0,
"maxSize": 0,
"metricScaleRules": [
{
"action": {
"cooldown": 0,
"type": "string",
"value": 0
},
"trigger": {
"evaluationPeriods": 0,
"metric": "string",
"operator": "string",
"period": 0,
"statistic": "string",
"threshold": "number"
}
}
],
"minSize": 0,
"policy": "string",
"scheduledScaleRules": [
{
"desiredCapacity": 0,
"maxSize": 0,
"minSize": 0,
"recurrence": "string"
}
]
},
"awsVpcId": "string",
"cloudConfig": "string",
"cloudConfigSettings": {
"deploymentFailOnCloudConfigRuntimeError": false,
"phoneHomeFailOnTimeout": false,
"phoneHomeShouldWait": false,
"phoneHomeTimeoutSeconds": 0
},
"constraints": [
{
"tag": "string"
}
],
"count": 0,
"dedicatedInstance": false,
"externalLink": "string",
"flavor": "string",
"flavorRef": "string",
"iamInstanceProfileName": "string",
"ignoreActiveDirectory": "string",
"image": "string",
"imageRef": "string",
"machineType": "string",
"name": "string",
"networks": [
{
"address": "string",
"assignPublicIpAddress": false,
"assignment": "string",
"deviceIndex": 0,
"network": "string"
}
],
"osType": "string",
"powerState": "string",
"project": "string",
"providerId": "string",
"region": "string",
"remoteAccess": {
"authentication": "string",
"keyPair": "string",
"password": "string",
"privateKey": "string",
"sshKey": "string",
"username": "string"
},
"resourceName": "string",
"spotDurationInHrs": 0,
"storage": {
"bootDiskCapacityInGB": 0,
"constraints": [
{
"tag": "string"
}
],
"encrypted": false,
"maxDiskCapacityInGB": 0
},
"tags": [
{
"key": "string",
"value": "string"
}
],
"zone": "string"
}
Cloud Account indicates the name of the endpoint used to provision this machine.
Active Directory Configuration
Machine IP address, populated by discovery or provisioning.
List of disks to attach to the machine.
Settings for an auto scaling group for this machine, which automatically increases or decreases resources based on policies.
Amazon VPC to which the EC2 instance will be provisioned. This property is computed and not available for user input.
When provisioning an instance, machine cloud-init startup instructions from user data fields. Sample cloud config instructions:
#cloud-config
repo_update: true
repo_upgrade: all
packages:
- httpd
- mariadb-server
runcmd:
- [ sh, -c, "amazon-linux-extras install -y lamp-mariadb10.2-php7.2 php7.2" ]
- systemctl start httpd
- sudo systemctl enable httpd
Specify how the provided Cloud Config should be handled
To target the correct resources, blueprint constraints are matched against infrastructure capability tags. Constraints must include the key name. Options include value, negative[!], and hard or soft requirement.
The number of resource instances to be created.
Dedicated Instances are Amazon EC2 instances that run in a VPC on hardware that's dedicated to a single customer.
URL to the machine on the AWS console.
Generic types of compute resources, mapped in an environment to specific types of compute resources.
Provider specific flavor reference. Valid if no flavor property is provided.
Name of an IAM instance profile. The profile is used to pass an IAM role to the EC2 instance
Indicates that the machine is not added to Active Directory by a policy. It skips the Active Directory policy.
Generic compute images, mapped in an environment to specific compute resource images.
Amazon machine image used for the EC2 machine.
The machine type. For example, spot for temporary machines.
Machine name.
Networks to attach to the machine. Multiple network interfaces are allowed.
Operating system of the machine, populated by discovery or provisioning. Values include WINDOWS and LINUX.
Machine power state of ON, OFF, GUEST_OFF, UNKNOWN, or SUSPEND.
Cloud Assembly project under which the machine is provisioned. Indicates project ID.
A unique identifier of the resource in the context of the provider.
Region name of the instance where machine landed.
Settings to remotely connect to the provisioned machine, by public/private key pair or username/password authentication. AWS supports key pair but not username/password.
The actual name of the machine determined after the allocation.
Lifespan of a spot machine. Range is 1–6 hours.
Settings for constraining to the correct storage at provisioning time.
Resource categorization, in case-sensitive key names, or in key-value pairs.
Availability zone of the instance where machine landed.