AWS::EC2::Instance - AWS CloudFormation (original) (raw)

Specifies an EC2 instance.

If an Elastic IP address is attached to your instance, AWS CloudFormation reattaches the Elastic IP address after it updates the instance. For more information about updating stacks, see AWS CloudFormation Stacks Updates.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EC2::Instance",
  "Properties" : {
      "AdditionalInfo" : String,
      "Affinity" : String,
      "AvailabilityZone" : String,
      "BlockDeviceMappings" : [ BlockDeviceMapping, ... ],
      "CpuOptions" : CpuOptions,
      "CreditSpecification" : CreditSpecification,
      "DisableApiTermination" : Boolean,
      "EbsOptimized" : Boolean,
      "ElasticGpuSpecifications" : [ ElasticGpuSpecification, ... ],
      "ElasticInferenceAccelerators" : [ ElasticInferenceAccelerator, ... ],
      "EnclaveOptions" : EnclaveOptions,
      "HibernationOptions" : HibernationOptions,
      "HostId" : String,
      "HostResourceGroupArn" : String,
      "IamInstanceProfile" : String,
      "ImageId" : String,
      "InstanceInitiatedShutdownBehavior" : String,
      "InstanceType" : String,
      "Ipv6AddressCount" : Integer,
      "Ipv6Addresses" : [ InstanceIpv6Address, ... ],
      "KernelId" : String,
      "KeyName" : String,
      "LaunchTemplate" : LaunchTemplateSpecification,
      "LicenseSpecifications" : [ LicenseSpecification, ... ],
      "Monitoring" : Boolean,
      "NetworkInterfaces" : [ NetworkInterface, ... ],
      "PlacementGroupName" : String,
      "PrivateDnsNameOptions" : PrivateDnsNameOptions,
      "PrivateIpAddress" : String,
      "PropagateTagsToVolumeOnCreation" : Boolean,
      "RamdiskId" : String,
      "SecurityGroupIds" : [ String, ... ],
      "SecurityGroups" : [ String, ... ],
      "SourceDestCheck" : Boolean,
      "SsmAssociations" : [ SsmAssociation, ... ],
      "SubnetId" : String,
      "Tags" : [ Tag, ... ],
      "Tenancy" : String,
      "UserData" : String,
      "Volumes" : [ Volume, ... ]
    }
}

Properties

AdditionalInfo

This property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).

Required: No

Type: String

Update requires: Some interruptions

Affinity

Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specifyhost. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specifydefault.

Required: No

Type: String

Allowed values: default | host

Update requires: Some interruptions

AvailabilityZone

The Availability Zone of the instance.

If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

This parameter is not supported by DescribeImageAttribute.

Required: No

Type: String

Update requires: Replacement

BlockDeviceMappings

The block device mapping entries that defines the block devices to attach to the instance at launch.

By default, the block devices specified in the block device mapping for the AMI are used. You can override the AMI block device mapping using the instance block device mapping. For the root volume, you can override only the volume size, volume type, volume encryption settings, and the DeleteOnTermination setting.

Important

After the instance is running, you can modify only theDeleteOnTermination parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance replacement.

Required: No

Type: Array of BlockDeviceMapping

Update requires: Some interruptions

CpuOptions

The CPU options for the instance. For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.

Required: No

Type: CpuOptions

Update requires: Replacement

CreditSpecification

The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.

Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)

For T3 instances with host tenancy, only standard is supported.

Required: No

Type: CreditSpecification

Update requires: No interruption

DisableApiTermination

Indicates whether termination protection is enabled for the instance. The default is false, which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped.

Required: No

Type: Boolean

Update requires: No interruption

EbsOptimized

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

Required: No

Type: Boolean

Update requires: Some interruptions

ElasticGpuSpecifications

An elastic GPU to associate with the instance.

Note

Amazon Elastic Graphics reached end of life on January 8, 2024.

Required: No

Type: Array of ElasticGpuSpecification

Update requires: Replacement

ElasticInferenceAccelerators

An elastic inference accelerator to associate with the instance.

Note

Amazon Elastic Inference is no longer available.

Required: No

Type: Array of ElasticInferenceAccelerator

Update requires: Replacement

EnclaveOptions

Indicates whether the instance is enabled for AWS Nitro Enclaves.

Required: No

Type: EnclaveOptions

Update requires: Replacement

HibernationOptions

Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.

You can't enable hibernation and AWS Nitro Enclaves on the same instance.

Required: No

Type: HibernationOptions

Update requires: Replacement

HostId

If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account. This type of launch is called an untargeted launch. Note that for untargeted launches, you must have a compatible, dedicated host available to successfully launch instances.

Required: No

Type: String

Update requires: Some interruptions

HostResourceGroupArn

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

Required: No

Type: String

Update requires: Replacement

IamInstanceProfile

The name of an IAM instance profile. To create a new IAM instance profile, use theAWS::IAM::InstanceProfile resource.

Required: No

Type: String

Update requires: No interruption

ImageId

The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.

Required: Conditional

Type: String

Update requires: Replacement

InstanceInitiatedShutdownBehavior

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

Required: No

Type: String

Allowed values: stop | terminate

Update requires: No interruption

InstanceType

The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

When you change your EBS-backed instance type, instance restart or replacement behavior depends on the instance type compatibility between the old and new types. An instance with an instance store volume as the root volume is always replaced. For more information, see Change the instance type in the Amazon EC2 User Guide.

Required: No

Type: String

Update requires: Some interruptions

Ipv6AddressCount

The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

Required: No

Type: Integer

Update requires: Replacement

Ipv6Addresses

The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

Required: No

Type: Array of InstanceIpv6Address

Update requires: Replacement

KernelId

The ID of the kernel.

Important

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the_Amazon EC2 User Guide_.

Required: No

Type: String

Update requires: Some interruptions

KeyName

The name of the key pair. You can create a key pair using CreateKeyPair orImportKeyPair.

Important

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

Required: No

Type: String

Update requires: Replacement

LaunchTemplate

The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.

Required: No

Type: LaunchTemplateSpecification

Update requires: Replacement

LicenseSpecifications

The license configurations.

Required: No

Type: Array of LicenseSpecification

Update requires: Replacement

Monitoring

Specifies whether detailed monitoring is enabled for the instance. Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled. For more information about detailed monitoring, see Enable or turn off detailed monitoring for your instances in the Amazon EC2 User Guide.

Required: No

Type: Boolean

Update requires: No interruption

NetworkInterfaces

The network interfaces to associate with the instance.

Note

If you use this property to point to a network interface, you must terminate the original interface before attaching a new one to allow the update of the instance to succeed.

If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn Attribute to declare a dependency on the VPC-gateway attachment.

Required: No

Type: Array of NetworkInterface

Update requires: Replacement

PlacementGroupName

The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).

Required: No

Type: String

Update requires: Replacement

PrivateDnsNameOptions

The options for the instance hostname.

Required: No

Type: PrivateDnsNameOptions

Update requires: Some interruptions

PrivateIpAddress

The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.

You cannot specify this option and the network interfaces option in the same request.

If you make an update to an instance that requires replacement, you must assign a new private IP address. During a replacement, AWS CloudFormation creates a new instance but doesn't delete the old instance until the stack has successfully updated. If the stack update fails, AWS CloudFormation uses the old instance to roll back the stack to the previous working state. The old and new instances cannot have the same private IP address.

Required: No

Type: String

Update requires: Replacement

PropagateTagsToVolumeOnCreation

Indicates whether to assign the tags specified in the Tags property to the volumes specified in the BlockDeviceMappings property.

Note that using this feature does not assign the tags to volumes that are created separately and then attached using AWS::EC2::VolumeAttachment.

Required: No

Type: Boolean

Update requires: No interruption

RamdiskId

The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.

Important

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the_Amazon EC2 User Guide_.

Required: No

Type: String

Update requires: Some interruptions

SecurityGroupIds

The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template.

If you specify a network interface, you must specify any security groups as part of the network interface.

Required: Conditional

Type: Array of String

Update requires: Some interruptions

SecurityGroups

[Default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

You cannot specify this option and the network interfaces option in the same request. The list can contain both the name of existing Amazon EC2 security groups or references to AWS::EC2::SecurityGroup resources created in the template.

Default: Amazon EC2 uses the default security group.

Required: No

Type: Array of String

Update requires: Replacement

SourceDestCheck

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

Required: No

Type: Boolean

Update requires: No interruption

SsmAssociations

The SSM document and parameter values in AWS Systems Manager to associate with this instance. To use this property, you must specify an IAM instance profile role for the instance. For more information, see Create an IAM instance profile for Systems Manager in the AWS Systems Manager User Guide.

Note

You can associate only one document with an instance.

Required: No

Type: Array of SsmAssociation

Update requires: No interruption

SubnetId

The ID of the subnet to launch the instance into.

If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.

Required: No

Type: String

Update requires: Replacement

Tags

The tags to add to the instance. These tags are not applied to the EBS volumes, such as the root volume, unless PropagateTagsToVolumeOnCreation is true.

Required: No

Type: Array of Tag

Update requires: No interruption

Tenancy

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.

Required: No

Type: String

Allowed values: default | dedicated | host

Update requires: Some interruptions

UserData

The parameters or scripts to store as user data. Any scripts in user data are run when you launch the instance. User data is limited to 16 KB. You must provide base64-encoded text. For more information, see Fn::Base64.

If the root volume is an EBS volume and you update user data, CloudFormation restarts the instance. If the root volume is an instance store volume and you update user data, the instance is replaced.

Required: No

Type: String

Update requires: Some interruptions

Volumes

The volumes to attach to the instance.

Required: No

Type: Array of Volume

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the instance ID. For example:i-1234567890abcdef0.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

InstanceId

The ID of the instance.

PrivateDnsName

The private DNS name of the specified instance. For example:ip-10-24-34-0.ec2.internal.

PrivateIp

The private IP address of the specified instance. For example:10.24.34.0.

PublicDnsName

The public DNS name of the specified instance. For example:ec2-107-20-50-45.compute-1.amazonaws.com.

PublicIp

The public IP address of the specified instance. For example:192.0.2.0.

VpcId

The ID of the VPC in which the instance is running.

Examples

EC2 instance with an EBS block device mapping
EC2 instance with user data
Launch an instance from a launch template
Automatically assign a public IP address

EC2 instance with an EBS block device mapping

The following example creates an EC2 instance with a block device mapping with an entry that specifies an io1 volume with a size of 20 GB and an entry that uses NoDevice to override a device specified in the AMI block device mapping.

JSON

"MyEC2Instance" : {
   "Type" : "AWS::EC2::Instance",
   "Properties" : {
      "ImageId" : "ami-79fd7eee",
      "KeyName" : "testkey",
      "BlockDeviceMappings" : [
         {
            "DeviceName" : "/dev/sdm",
            "Ebs" : {
              "VolumeType" : "io1",
              "Iops" : "200",
              "DeleteOnTermination" : "false",
              "VolumeSize" : "20"
            }
          }, 
          {
            "DeviceName" : "/dev/sdk",
            "NoDevice" : {}
          }
      ]
   }
}

YAML

  MyEC2Instance: 
    Type: AWS::EC2::Instance
    Properties: 
      ImageId: "ami-79fd7eee"
      KeyName: "testkey"
      BlockDeviceMappings: 
      - DeviceName: "/dev/sdm"
        Ebs: 
          VolumeType: "io1"
          Iops: "200"
          DeleteOnTermination: "false"
          VolumeSize: "20"
      - DeviceName: "/dev/sdk"
        NoDevice: {}

EC2 instance with user data

The following example creates an EC2 instance with user data. The user data must be base64-encoded.

JSON

{
    "Resources": {
        "myInstance": {
            "Type": "AWS::EC2::Instance",
            "Properties": {
                "ImageId": "ami-0a70b9d193ae8a799",
                "InstanceType": "t2.micro",
                "KeyName": "my-key-pair",
                "SecurityGroupIds": [
                    "sg-12a4c434"
                ],
                "UserData": {
                    "Fn::Base64": {
                        "Fn::Sub": "#!/bin/bash\nyum update -y\nservice httpd start\nchkconfig httpd on\n"
                    }
                }
            }
        }
    }
}

YAML

Resources:
   myInstance:
     Type: 'AWS::EC2::Instance'
     Properties: 
        ImageId: ami-0a70b9d193ae8a799
        InstanceType: t2.micro
        KeyName: my-key-pair
        SecurityGroupIds:
          - sg-12a4c434
        UserData:
          Fn::Base64: !Sub |
             #!/bin/bash
             yum update -y
             service httpd start
             chkconfig httpd on

Launch an instance from a launch template

You can use the parameters contained in a launch template to launch an instance. The following example defines a launch template that specifies an AMI, instance type, security group, and tag for the instance. It also enables access to the instance tags through instance metadata.

JSON

{
    "Resources": {
        "myInstance": {
            "Type": "AWS::EC2::Instance",
            "Properties": {
                "LaunchTemplate": {
                    "LaunchTemplateId": {
                        "Ref": "myLaunchTemplate"
                    },
                    "Version": {
                        "Fn::GetAtt": [
                            "myLaunchTemplate",
                            "DefaultVersionNumber"
                        ]
                    }
                }
            }
        },
        "myLaunchTemplate": {
            "Type": "AWS::EC2::LaunchTemplate",
            "Properties": {
                "LaunchTemplateData": {
                    "ImageId": "ami-0a70b9d193ae8a799",
                    "InstanceType": "t2.micro",
                    "MetadataOptions": {
                        "InstanceMetadataTags": "enabled"
                    },
                    "SecurityGroupIds": [
                        "sg-12a4c434"
                    ],
                    "TagSpecifications": [
                        {
                            "ResourceType": "instance",
                            "Tags": [
                                {
                                    "Key": "department",
                                    "Value": "dev"
                                }
                            ]
                        }
                    ]
                }
            }
        }
    }
}

YAML

Resources:
   myInstance:
     Type: 'AWS::EC2::Instance'
     Properties: 
        LaunchTemplate:
          LaunchTemplateId: !Ref myLaunchTemplate
          Version: !GetAtt myLaunchTemplate.DefaultVersionNumber
   myLaunchTemplate:
     Type: 'AWS::EC2::LaunchTemplate'
     Properties:
       LaunchTemplateData:
          ImageId: ami-0a70b9d193ae8a799
          InstanceType: t2.micro
          MetadataOptions: 
            InstanceMetadataTags: enabled
          SecurityGroupIds:
            - sg-12a4c434
          TagSpecifications:
            - ResourceType: instance
              Tags:
              - Key: department
                Value: dev

Automatically assign a public IP address

You can associate a public IP address with a network interface only if it is the primary network interface (the device index is 0) and if you are creating a new network interface, not attaching an existing network interface.

JSON

"Ec2Instance" : {
  "Type" : "AWS::EC2::Instance",
  "Properties" : {
    "ImageId" : { "Fn::FindInMap" : [ "RegionMap", { "Ref" : "AWS::Region" }, "AMI" ]},
    "KeyName" : { "Ref" : "KeyName" },
    "NetworkInterfaces": [ {
      "AssociatePublicIpAddress": "true",
      "DeviceIndex": "0",
      "GroupSet": [{ "Ref" : "myVPCEC2SecurityGroup" }],
      "SubnetId": { "Ref" : "PublicSubnet" }
    } ]
  }
}

YAML

Ec2Instance: 
  Type: AWS::EC2::Instance
  Properties: 
    ImageId: 
      Fn::FindInMap: 
        - "RegionMap"
        - Ref: "AWS::Region"
        - "AMI"
    KeyName: 
      Ref: "KeyName"
    NetworkInterfaces: 
      - AssociatePublicIpAddress: "true"
        DeviceIndex: "0"
        GroupSet: 
          - Ref: "myVPCEC2SecurityGroup"
        SubnetId: 
          Ref: "PublicSubnet"

AWS::EC2::Instance - AWS CloudFormation (original) (raw)

Syntax

JSON

Properties

Important

Note

Note

Important

Important

Note

Important

Note

Return values

Ref

Fn::GetAtt

Examples

EC2 instance with an EBS block device mapping

JSON

YAML

EC2 instance with user data

JSON

YAML

Launch an instance from a launch template

JSON

YAML

Automatically assign a public IP address

JSON

YAML

See also