Skip to main content

AWS EC2

Properties

NameTypeDescriptionRequired
ami
(AMI configuration)
objectyes
scaling
(Scaling configuration)
objectno
storage
(Storage configuration)
objectno
security
(Security configuration)
objectyes

Additional Properties: not allowed
Example

{
"ami": {
"id": "ami-0123456789abcdef0",
"gpu_id": "ami-0123456789abcdef0"
},
"scaling": {},
"storage": {
"parameters_bucket": "my-params-bucket",
"parameters_encryption_secret": "my-secret-name"
},
"security": {
"ssh_key": "my-ssh-key",
"iam_profile": "arn:aws:iam::123456789012:instance-profile/my-instance-profile"
}
}

ami: AMI configuration

Properties

NameTypeDescriptionRequired
id
(AMI ID)
stringThe ID of the Amazon Machine Image (AMI) to use for EC2 instances
Pattern: ^ami-[a-f0-9]{8,17}$
yes
gpu_id
(GPU AMI ID)
stringThe ID of the GPU-enabled Amazon Machine Image (AMI)
Pattern: ^ami-[a-f0-9]{8,17}$
no

Example

{
"id": "ami-0123456789abcdef0",
"gpu_id": "ami-0123456789abcdef0"
}

scaling: Scaling configuration

Properties

NameTypeDescriptionRequired
use_autoscaling_management
(Auto Scaling)
booleanEnable autoscaling management during deployments using scale in policies

storage: Storage configuration

Properties

NameTypeDescriptionRequired
parameters_bucket
(Parameters S3 Bucket)
stringThe name of the S3 bucket used for storing parameters
Minimal Length: 3
Maximal Length: 63
Pattern: ^[a-z0-9](?:[a-z0-9.-]{1,61}[a-z0-9])?$
parameters_encryption_secret
(Parameters Encryption Secret Name)
stringThe name of the secret used for parameters encryption

Example

{
"parameters_bucket": "my-params-bucket",
"parameters_encryption_secret": "my-secret-name"
}

security: Security configuration

Properties

NameTypeDescriptionRequired
ssh_key
(SSH Key Name)
stringThe name of the SSH key pair for EC2 instance access
Pattern: ^[a-zA-Z0-9-_]+$
no
iam_profile
(IAM Instance Profile ARN)
stringThe ARN of the IAM instance profile to attach to EC2 instances
Pattern: ^arn:aws:iam::[0-9]{12}:instance-profile/[a-zA-Z0-9+=,.@_-]+$
yes

Example

{
"ssh_key": "my-ssh-key",
"iam_profile": "arn:aws:iam::123456789012:instance-profile/my-instance-profile"
}