CloudFormation Compatible Resource Types

AWS::EC2::EIP

Optional Properties

InstanceId

Instance ID to associate with EIP.

String value expected.

Can be updated without replacement.

Value must be of type nova.server

Domain

DEPRECATED since 9.0.0 (Pike) - Now we only allow vpc here, so no need to set up this tag anymore.

Set to “vpc” to have IP address allocation associated to your VPC.

String value expected.

Updates cause replacement.

Allowed values: “vpc”

Attributes

AllocationId

ID that AWS assigns to represent the allocation of the address for use with Amazon VPC. Returned only for VPC elastic IP addresses.

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::EIP
    properties:
      InstanceId: String

AWS::EC2::EIPAssociation

Optional Properties

AllocationId

Allocation ID for VPC EIP address.

String value expected.

Can be updated without replacement.

EIP

EIP address to associate with instance.

String value expected.

Can be updated without replacement.

Value must be of type ip_addr

InstanceId

Instance ID to associate with EIP specified by EIP property.

String value expected.

Can be updated without replacement.

Value must be of type nova.server

NetworkInterfaceId

Network interface ID to associate with EIP.

String value expected.

Can be updated without replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::EIPAssociation
    properties:
      AllocationId: String
      EIP: String
      InstanceId: String
      NetworkInterfaceId: String

AWS::EC2::Instance

Required Properties

ImageId

Glance image ID or name.

String value expected.

Updates cause replacement.

Value must be of type glance.image

InstanceType

Nova instance type (flavor).

String value expected.

Can be updated without replacement.

Value must be of type nova.flavor

Optional Properties

AvailabilityZone

Availability zone to launch the instance in.

String value expected.

Updates cause replacement.

BlockDeviceMappings

Block device mappings to attach to instance.

List value expected.

Updates cause replacement.

List contents:

Map value expected.

Updates cause replacement.

Map properties:

DeviceName

Required.

A device name where the volume will be attached in the system at /dev/device_name.e.g. vdb

String value expected.

Updates cause replacement.

Ebs

The ebs volume to attach to the instance.

Map value expected.

Updates cause replacement.

Map properties:

DeleteOnTermination

Optional.

Indicate whether the volume should be deleted when the instance is terminated.

Boolean value expected.

Updates cause replacement.

Defaults to true

Iops

Not implemented.

SnapshotId

Optional.

The ID of the snapshot to create a volume from.

String value expected.

Updates cause replacement.

Value must be of type cinder.snapshot

VolumeSize

Optional.

The size of the volume, in GB. Must be equal or greater than the size of the snapshot. It is safe to leave this blank and have the Compute service infer the size.

String value expected.

Updates cause replacement.

VolumeType

Not implemented.

NoDevice

Not implemented.

VirtualName

Not implemented.

DisableApiTermination

Note

Not implemented.

KernelId

Note

Not implemented.

KeyName

Optional Nova keypair name.

String value expected.

Updates cause replacement.

Value must be of type nova.keypair

Monitoring

Note

Not implemented.

NetworkInterfaces

Network interfaces to associate with instance.

List value expected.

Can be updated without replacement.

NovaSchedulerHints

Scheduler hints to pass to Nova (Heat extension).

List value expected.

Updates cause replacement.

List contents:

Map value expected.

Updates cause replacement.

Map properties:

Key

Required.

String value expected.

Updates cause replacement.

Value

Required.

String value expected.

Updates cause replacement.

PlacementGroupName

Note

Not implemented.

PrivateIpAddress

Note

Not implemented.

RamDiskId

Note

Not implemented.

SecurityGroupIds

Security group IDs to assign.

List value expected.

Updates cause replacement.

SecurityGroups

Security group names to assign.

List value expected.

Updates cause replacement.

SourceDestCheck

Note

Not implemented.

SubnetId

Subnet ID to launch instance in.

String value expected.

Can be updated without replacement.

Tags

Tags to attach to instance.

List value expected.

Can be updated without replacement.

List contents:

Map value expected.

Can be updated without replacement.

Map properties:

Key

Required.

String value expected.

Can be updated without replacement.

Value

Required.

String value expected.

Can be updated without replacement.

Tenancy

Note

Not implemented.

UserData

User data to pass to instance.

String value expected.

Updates cause replacement.

Volumes

Volumes to attach to instance.

List value expected.

Updates cause replacement.

Defaults to []

List contents:

Map value expected.

Updates cause replacement.

Map properties:

Device

Required.

The device where the volume is exposed on the instance. This assignment may not be honored and it is advised that the path /dev/disk/by-id/virtio-<VolumeId> be used instead.

String value expected.

Updates cause replacement.

VolumeId

Required.

The ID of the volume to be attached.

String value expected.

Updates cause replacement.

Value must be of type cinder.volume

Attributes

AvailabilityZone

The Availability Zone where the specified instance is launched.

PrivateDnsName

Private DNS name of the specified instance.

PrivateIp

Private IP address of the specified instance.

PublicDnsName

Public DNS name of the specified instance.

PublicIp

Public IP address of the specified instance.

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::Instance
    properties:
      AvailabilityZone: String
      BlockDeviceMappings: [{"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "SnapshotId": String, "VolumeSize": String}}, {"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "SnapshotId": String, "VolumeSize": String}}, ...]
      ImageId: String
      InstanceType: String
      KeyName: String
      NetworkInterfaces: [Value, Value, ...]
      NovaSchedulerHints: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]
      SecurityGroupIds: [Value, Value, ...]
      SecurityGroups: [Value, Value, ...]
      SubnetId: String
      Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]
      UserData: String
      Volumes: [{"Device": String, "VolumeId": String}, {"Device": String, "VolumeId": String}, ...]

AWS::EC2::InternetGateway

Optional Properties

Tags

List value expected.

Updates cause replacement.

List contents:

Not implemented.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::InternetGateway
    properties:
      Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]

AWS::EC2::NetworkInterface

Required Properties

SubnetId

Subnet ID to associate with this interface.

String value expected.

Updates cause replacement.

Value must be of type neutron.subnet

Optional Properties

Description

Description for this interface.

String value expected.

Updates cause replacement.

GroupSet

List of security group IDs associated with this interface.

List value expected.

Can be updated without replacement.

PrivateIpAddress

String value expected.

Updates cause replacement.

SourceDestCheck

Note

Not implemented.

Tags

List value expected.

Updates cause replacement.

List contents:

Not implemented.

Attributes

PrivateIpAddress

Private IP address of the network interface.

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::NetworkInterface
    properties:
      Description: String
      GroupSet: [Value, Value, ...]
      PrivateIpAddress: String
      SubnetId: String
      Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]

AWS::EC2::RouteTable

Available since 2014.1 (Icehouse)

Required Properties

VpcId

VPC ID for where the route table is created.

String value expected.

Updates cause replacement.

Optional Properties

Tags

List value expected.

Updates cause replacement.

List contents:

Not implemented.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::RouteTable
    properties:
      Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]
      VpcId: String

AWS::EC2::SecurityGroup

Required Properties

GroupDescription

Description of the security group.

String value expected.

Updates cause replacement.

Optional Properties

SecurityGroupEgress

List value expected.

Can be updated without replacement.

List contents:

List of security group egress rules.

Map value expected.

Can be updated without replacement.

Map properties:

CidrIp

Optional.

String value expected.

Can be updated without replacement.

FromPort

Optional.

String value expected.

Can be updated without replacement.

IpProtocol

Optional.

String value expected.

Can be updated without replacement.

SourceSecurityGroupId

Optional.

String value expected.

Can be updated without replacement.

SourceSecurityGroupName

Optional.

String value expected.

Can be updated without replacement.

SourceSecurityGroupOwnerId

Not implemented.

ToPort

Optional.

String value expected.

Can be updated without replacement.

SecurityGroupIngress

List value expected.

Can be updated without replacement.

List contents:

List of security group ingress rules.

Map value expected.

Can be updated without replacement.

Map properties:

CidrIp

Optional.

String value expected.

Can be updated without replacement.

FromPort

Optional.

String value expected.

Can be updated without replacement.

IpProtocol

Optional.

String value expected.

Can be updated without replacement.

SourceSecurityGroupId

Optional.

String value expected.

Can be updated without replacement.

SourceSecurityGroupName

Optional.

String value expected.

Can be updated without replacement.

SourceSecurityGroupOwnerId

Not implemented.

ToPort

Optional.

String value expected.

Can be updated without replacement.

VpcId

Physical ID of the VPC. Not implemented.

String value expected.

Updates cause replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::SecurityGroup
    properties:
      GroupDescription: String
      SecurityGroupEgress: [{"CidrIp": String, "FromPort": String, "ToPort": String, "IpProtocol": String, "SourceSecurityGroupId": String, "SourceSecurityGroupName": String}, {"CidrIp": String, "FromPort": String, "ToPort": String, "IpProtocol": String, "SourceSecurityGroupId": String, "SourceSecurityGroupName": String}, ...]
      SecurityGroupIngress: [{"CidrIp": String, "FromPort": String, "ToPort": String, "IpProtocol": String, "SourceSecurityGroupId": String, "SourceSecurityGroupName": String}, {"CidrIp": String, "FromPort": String, "ToPort": String, "IpProtocol": String, "SourceSecurityGroupId": String, "SourceSecurityGroupName": String}, ...]
      VpcId: String

AWS::EC2::Subnet

Required Properties

CidrBlock

CIDR block to apply to subnet.

String value expected.

Updates cause replacement.

VpcId

Ref structure that contains the ID of the VPC on which you want to create the subnet.

String value expected.

Updates cause replacement.

Optional Properties

AvailabilityZone

Availability zone in which you want the subnet.

String value expected.

Updates cause replacement.

Tags

List value expected.

Updates cause replacement.

List contents:

Not implemented.

Attributes

AvailabilityZone

Availability Zone of the subnet.

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::Subnet
    properties:
      AvailabilityZone: String
      CidrBlock: String
      Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]
      VpcId: String

AWS::EC2::SubnetRouteTableAssociation

Required Properties

RouteTableId

Route table ID.

String value expected.

Updates cause replacement.

SubnetId

Subnet ID.

String value expected.

Updates cause replacement.

Value must be of type neutron.subnet

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::SubnetRouteTableAssociation
    properties:
      RouteTableId: String
      SubnetId: String

AWS::EC2::VPC

Optional Properties

CidrBlock

CIDR block to apply to the VPC.

String value expected.

Updates cause replacement.

InstanceTenancy

Note

Not implemented.

Tags

List value expected.

Updates cause replacement.

List contents:

Not implemented.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::VPC
    properties:
      CidrBlock: String
      Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]

AWS::EC2::VPCGatewayAttachment

Required Properties

VpcId

VPC ID for this gateway association.

String value expected.

Updates cause replacement.

Optional Properties

InternetGatewayId

ID of the InternetGateway.

String value expected.

Updates cause replacement.

VpnGatewayId

Note

Not implemented.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::VPCGatewayAttachment
    properties:
      InternetGatewayId: String
      VpcId: String

AWS::EC2::Volume

Required Properties

AvailabilityZone

The availability zone in which the volume will be created.

String value expected.

Updates are not supported. Resource update will fail on any attempt to update this property.

Optional Properties

Size

The size of the volume in GB.

Integer value expected.

Updates are not supported. Resource update will fail on any attempt to update this property.

The value must be at least 1.

SnapshotId

If specified, the backup used as the source to create the volume.

String value expected.

Updates are not supported. Resource update will fail on any attempt to update this property.

Value must be of type cinder.backup

Tags

The list of tags to associate with the volume.

List value expected.

Updates are not supported. Resource update will fail on any attempt to update this property.

List contents:

Map value expected.

Updates are not supported. Resource update will fail on any attempt to update this property.

Map properties:

Key

Required.

String value expected.

Updates are not supported. Resource update will fail on any attempt to update this property.

Value

Required.

String value expected.

Updates are not supported. Resource update will fail on any attempt to update this property.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::Volume
    properties:
      AvailabilityZone: String
      Size: Integer
      SnapshotId: String
      Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]

AWS::EC2::VolumeAttachment

Required Properties

Device

The device where the volume is exposed on the instance. This assignment may not be honored and it is advised that the path /dev/disk/by-id/virtio-<VolumeId> be used instead.

String value expected.

Updates are not supported. Resource update will fail on any attempt to update this property.

Value must match pattern: /dev/vd[b-z]

InstanceId

The ID of the instance to which the volume attaches.

String value expected.

Updates are not supported. Resource update will fail on any attempt to update this property.

Value must be of type nova.server

VolumeId

The ID of the volume to be attached.

String value expected.

Updates are not supported. Resource update will fail on any attempt to update this property.

Value must be of type cinder.volume

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::EC2::VolumeAttachment
    properties:
      Device: String
      InstanceId: String
      VolumeId: String