This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::EC2::Instance 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::EC2::Instance", "Properties" : { "[AdditionalInfo](#cfn-ec2-instance-additionalinfo)" : String, "[Affinity](#cfn-ec2-instance-affinity)" : String, "[AvailabilityZone](#cfn-ec2-instance-availabilityzone)" : String, "[BlockDeviceMappings](#cfn-ec2-instance-blockdevicemappings)" : [ BlockDeviceMapping, ... ], "[CpuOptions](#cfn-ec2-instance-cpuoptions)" : CpuOptions, "[CreditSpecification](#cfn-ec2-instance-creditspecification)" : CreditSpecification, "[DisableApiTermination](#cfn-ec2-instance-disableapitermination)" : Boolean, "[EbsOptimized](#cfn-ec2-instance-ebsoptimized)" : Boolean, "[ElasticGpuSpecifications](#cfn-ec2-instance-elasticgpuspecifications)" : [ ElasticGpuSpecification, ... ], "[ElasticInferenceAccelerators](#cfn-ec2-instance-elasticinferenceaccelerators)" : [ ElasticInferenceAccelerator, ... ], "[EnclaveOptions](#cfn-ec2-instance-enclaveoptions)" : EnclaveOptions, "[HibernationOptions](#cfn-ec2-instance-hibernationoptions)" : HibernationOptions, "[HostId](#cfn-ec2-instance-hostid)" : String, "[HostResourceGroupArn](#cfn-ec2-instance-hostresourcegrouparn)" : String, "[IamInstanceProfile](#cfn-ec2-instance-iaminstanceprofile)" : String, "[ImageId](#cfn-ec2-instance-imageid)" : String, "[InstanceInitiatedShutdownBehavior](#cfn-ec2-instance-instanceinitiatedshutdownbehavior)" : String, "[InstanceType](#cfn-ec2-instance-instancetype)" : String, "[Ipv6AddressCount](#cfn-ec2-instance-ipv6addresscount)" : Integer, "[Ipv6Addresses](#cfn-ec2-instance-ipv6addresses)" : [ InstanceIpv6Address, ... ], "[KernelId](#cfn-ec2-instance-kernelid)" : String, "[KeyName](#cfn-ec2-instance-keyname)" : String, "[LaunchTemplate](#cfn-ec2-instance-launchtemplate)" : LaunchTemplateSpecification, "[LicenseSpecifications](#cfn-ec2-instance-licensespecifications)" : [ LicenseSpecification, ... ], "[MetadataOptions](#cfn-ec2-instance-metadataoptions)" : MetadataOptions, "[Monitoring](#cfn-ec2-instance-monitoring)" : Boolean, "[NetworkInterfaces](#cfn-ec2-instance-networkinterfaces)" : [ NetworkInterface, ... ], "[PlacementGroupName](#cfn-ec2-instance-placementgroupname)" : String, "[PrivateDnsNameOptions](#cfn-ec2-instance-privatednsnameoptions)" : PrivateDnsNameOptions, "[PrivateIpAddress](#cfn-ec2-instance-privateipaddress)" : String, "[PropagateTagsToVolumeOnCreation](#cfn-ec2-instance-propagatetagstovolumeoncreation)" : Boolean, "[RamdiskId](#cfn-ec2-instance-ramdiskid)" : String, "[SecurityGroupIds](#cfn-ec2-instance-securitygroupids)" : [ String, ... ], "[SecurityGroups](#cfn-ec2-instance-securitygroups)" : [ String, ... ], "[SourceDestCheck](#cfn-ec2-instance-sourcedestcheck)" : Boolean, "[SsmAssociations](#cfn-ec2-instance-ssmassociations)" : [ SsmAssociation, ... ], "[SubnetId](#cfn-ec2-instance-subnetid)" : String, "[Tags](#cfn-ec2-instance-tags)" : [ Tag, ... ], "[Tenancy](#cfn-ec2-instance-tenancy)" : String, "[UserData](#cfn-ec2-instance-userdata)" : String, "[Volumes](#cfn-ec2-instance-volumes)" : [ Volume, ... ] } } ``` ### YAML ``` Type: AWS::EC2::Instance Properties: [AdditionalInfo](#cfn-ec2-instance-additionalinfo): String [Affinity](#cfn-ec2-instance-affinity): String [AvailabilityZone](#cfn-ec2-instance-availabilityzone): String [BlockDeviceMappings](#cfn-ec2-instance-blockdevicemappings): - BlockDeviceMapping [CpuOptions](#cfn-ec2-instance-cpuoptions): CpuOptions [CreditSpecification](#cfn-ec2-instance-creditspecification): CreditSpecification [DisableApiTermination](#cfn-ec2-instance-disableapitermination): Boolean [EbsOptimized](#cfn-ec2-instance-ebsoptimized): Boolean [ElasticGpuSpecifications](#cfn-ec2-instance-elasticgpuspecifications): - ElasticGpuSpecification [ElasticInferenceAccelerators](#cfn-ec2-instance-elasticinferenceaccelerators): - ElasticInferenceAccelerator [EnclaveOptions](#cfn-ec2-instance-enclaveoptions): EnclaveOptions [HibernationOptions](#cfn-ec2-instance-hibernationoptions): HibernationOptions [HostId](#cfn-ec2-instance-hostid): String [HostResourceGroupArn](#cfn-ec2-instance-hostresourcegrouparn): String [IamInstanceProfile](#cfn-ec2-instance-iaminstanceprofile): String [ImageId](#cfn-ec2-instance-imageid): String [InstanceInitiatedShutdownBehavior](#cfn-ec2-instance-instanceinitiatedshutdownbehavior): String [InstanceType](#cfn-ec2-instance-instancetype): String [Ipv6AddressCount](#cfn-ec2-instance-ipv6addresscount): Integer [Ipv6Addresses](#cfn-ec2-instance-ipv6addresses): - InstanceIpv6Address [KernelId](#cfn-ec2-instance-kernelid): String [KeyName](#cfn-ec2-instance-keyname): String [LaunchTemplate](#cfn-ec2-instance-launchtemplate): LaunchTemplateSpecification [LicenseSpecifications](#cfn-ec2-instance-licensespecifications): - LicenseSpecification [MetadataOptions](#cfn-ec2-instance-metadataoptions): MetadataOptions [Monitoring](#cfn-ec2-instance-monitoring): Boolean [NetworkInterfaces](#cfn-ec2-instance-networkinterfaces): - NetworkInterface [PlacementGroupName](#cfn-ec2-instance-placementgroupname): String [PrivateDnsNameOptions](#cfn-ec2-instance-privatednsnameoptions): PrivateDnsNameOptions [PrivateIpAddress](#cfn-ec2-instance-privateipaddress): String [PropagateTagsToVolumeOnCreation](#cfn-ec2-instance-propagatetagstovolumeoncreation): Boolean [RamdiskId](#cfn-ec2-instance-ramdiskid): String [SecurityGroupIds](#cfn-ec2-instance-securitygroupids): - String [SecurityGroups](#cfn-ec2-instance-securitygroups): - String [SourceDestCheck](#cfn-ec2-instance-sourcedestcheck): Boolean [SsmAssociations](#cfn-ec2-instance-ssmassociations): - SsmAssociation [SubnetId](#cfn-ec2-instance-subnetid): String [Tags](#cfn-ec2-instance-tags): - Tag [Tenancy](#cfn-ec2-instance-tenancy): String [UserData](#cfn-ec2-instance-userdata): String [Volumes](#cfn-ec2-instance-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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `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, specify `host`. 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), specify `default`. *Required*: No *Type*: String *Allowed values*: `default | host` *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html). *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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. After the instance is running, you can modify only the `DeleteOnTermination` parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). *Required*: No *Type*: Array of [BlockDeviceMapping](aws-properties-ec2-instance-blockdevicemapping.md) *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `CpuOptions` The CPU options for the instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide*. *Required*: No *Type*: [CpuOptions](aws-properties-ec2-instance-cpuoptions.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html). For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) 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](aws-properties-ec2-instance-creditspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `ElasticGpuSpecifications` An elastic GPU to associate with the instance. Amazon Elastic Graphics reached end of life on January 8, 2024. *Required*: No *Type*: Array of [ElasticGpuSpecification](aws-properties-ec2-instance-elasticgpuspecification.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ElasticInferenceAccelerators` An elastic inference accelerator to associate with the instance. Amazon Elastic Inference is no longer available. *Required*: No *Type*: Array of [ElasticInferenceAccelerator](aws-properties-ec2-instance-elasticinferenceaccelerator.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnclaveOptions` Indicates whether the instance is enabled for AWS Nitro Enclaves. *Required*: No *Type*: [EnclaveOptions](aws-properties-ec2-instance-enclaveoptions.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `HibernationOptions` Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*. You can't enable hibernation and AWS Nitro Enclaves on the same instance. *Required*: No *Type*: [HibernationOptions](aws-properties-ec2-instance-hibernationoptions.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `IamInstanceProfile` The name of an IAM instance profile. To create a new IAM instance profile, use the [AWS::IAM::InstanceProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) resource. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InstanceType` The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html) in the *Amazon EC2 User Guide*. *Required*: No *Type*: String *Allowed values*: `a1.medium | a1.large | a1.xlarge | a1.2xlarge | a1.4xlarge | a1.metal | c1.medium | c1.xlarge | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.metal | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5ad.large | c5ad.xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5d.large | c5d.xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.metal | c5n.large | c5n.xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.18xlarge | c5n.metal | c6g.medium | c6g.large | c6g.xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.12xlarge | c6g.16xlarge | c6g.metal | c6gd.medium | c6gd.large | c6gd.xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.metal | c6gn.medium | c6gn.large | c6gn.xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.12xlarge | c6gn.16xlarge | c6i.large | c6i.xlarge | c6i.2xlarge | c6i.4xlarge | c6i.8xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.32xlarge | c6i.metal | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d3.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3en.xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.12xlarge | dl1.24xlarge | f1.2xlarge | f1.4xlarge | f1.16xlarge | g2.2xlarge | g2.8xlarge | g3.4xlarge | g3.8xlarge | g3.16xlarge | g3s.xlarge | g4ad.xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.16xlarge | g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.metal | g5.xlarge | g5.2xlarge | g5.4xlarge | g5.8xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.48xlarge | g5g.xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.16xlarge | g5g.metal | hi1.4xlarge | hpc6a.48xlarge | hs1.8xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | h1.16xlarge | i2.xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i3.large | i3.xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.16xlarge | i3.metal | i3en.large | i3en.xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.12xlarge | i3en.24xlarge | i3en.metal | im4gn.large | im4gn.xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.16xlarge | inf1.xlarge | inf1.2xlarge | inf1.6xlarge | inf1.24xlarge | is4gen.medium | is4gen.large | is4gen.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | m1.small | m1.medium | m1.large | m1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m4.16xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.metal | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5ad.large | m5ad.xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5d.large | m5d.xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.metal | m5dn.large | m5dn.xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.metal | m5n.large | m5n.xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.metal | m5zn.large | m5zn.xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.12xlarge | m5zn.metal | m6a.large | m6a.xlarge | m6a.2xlarge | m6a.4xlarge | m6a.8xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.32xlarge | m6a.48xlarge | m6g.metal | m6g.medium | m6g.large | m6g.xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.12xlarge | m6g.16xlarge | m6gd.metal | m6gd.medium | m6gd.large | m6gd.xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.12xlarge | m6gd.16xlarge | m6i.large | m6i.xlarge | m6i.2xlarge | m6i.4xlarge | m6i.8xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.32xlarge | m6i.metal | mac1.metal | p2.xlarge | p2.8xlarge | p2.16xlarge | p3.2xlarge | p3.8xlarge | p3.16xlarge | p3dn.24xlarge | p4d.24xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.metal | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5ad.large | r5ad.xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5b.large | r5b.xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.metal | r5d.large | r5d.xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.metal | r5dn.large | r5dn.xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.metal | r5n.large | r5n.xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.metal | r6g.medium | r6g.large | r6g.xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.12xlarge | r6g.16xlarge | r6g.metal | r6gd.medium | r6gd.large | r6gd.xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.metal | r6i.large | r6i.xlarge | r6i.2xlarge | r6i.4xlarge | r6i.8xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.32xlarge | r6i.metal | t1.micro | t2.nano | t2.micro | t2.small | t2.medium | t2.large | t2.xlarge | t2.2xlarge | t3.nano | t3.micro | t3.small | t3.medium | t3.large | t3.xlarge | t3.2xlarge | t3a.nano | t3a.micro | t3a.small | t3a.medium | t3a.large | t3a.xlarge | t3a.2xlarge | t4g.nano | t4g.micro | t4g.small | t4g.medium | t4g.large | t4g.xlarge | t4g.2xlarge | u-6tb1.56xlarge | u-6tb1.112xlarge | u-9tb1.112xlarge | u-12tb1.112xlarge | u-6tb1.metal | u-9tb1.metal | u-12tb1.metal | u-18tb1.metal | u-24tb1.metal | vt1.3xlarge | vt1.6xlarge | vt1.24xlarge | x1.16xlarge | x1.32xlarge | x1e.xlarge | x1e.2xlarge | x1e.4xlarge | x1e.8xlarge | x1e.16xlarge | x1e.32xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.12xlarge | x2iezn.metal | x2gd.medium | x2gd.large | x2gd.xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.metal | z1d.large | z1d.xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.12xlarge | z1d.metal | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2iedn.xlarge | x2iedn.2xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.32xlarge | c6a.large | c6a.xlarge | c6a.2xlarge | c6a.4xlarge | c6a.8xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.32xlarge | c6a.48xlarge | c6a.metal | m6a.metal | i4i.large | i4i.xlarge | i4i.2xlarge | i4i.4xlarge | i4i.8xlarge | i4i.16xlarge | i4i.32xlarge | i4i.metal | x2idn.metal | x2iedn.metal | c7g.medium | c7g.large | c7g.xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.12xlarge | c7g.16xlarge | mac2.metal | c6id.large | c6id.xlarge | c6id.2xlarge | c6id.4xlarge | c6id.8xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.32xlarge | c6id.metal | m6id.large | m6id.xlarge | m6id.2xlarge | m6id.4xlarge | m6id.8xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.32xlarge | m6id.metal | r6id.large | r6id.xlarge | r6id.2xlarge | r6id.4xlarge | r6id.8xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.32xlarge | r6id.metal | r6a.large | r6a.xlarge | r6a.2xlarge | r6a.4xlarge | r6a.8xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.32xlarge | r6a.48xlarge | r6a.metal | p4de.24xlarge | u-3tb1.56xlarge | u-18tb1.112xlarge | u-24tb1.112xlarge | trn1.2xlarge | trn1.32xlarge | hpc6id.32xlarge | c6in.large | c6in.xlarge | c6in.2xlarge | c6in.4xlarge | c6in.8xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.32xlarge | m6in.large | m6in.xlarge | m6in.2xlarge | m6in.4xlarge | m6in.8xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.32xlarge | m6idn.large | m6idn.xlarge | m6idn.2xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.32xlarge | r6in.large | r6in.xlarge | r6in.2xlarge | r6in.4xlarge | r6in.8xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.32xlarge | r6idn.large | r6idn.xlarge | r6idn.2xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.32xlarge | c7g.metal | m7g.medium | m7g.large | m7g.xlarge | m7g.2xlarge | m7g.4xlarge | m7g.8xlarge | m7g.12xlarge | m7g.16xlarge | m7g.metal | r7g.medium | r7g.large | r7g.xlarge | r7g.2xlarge | r7g.4xlarge | r7g.8xlarge | r7g.12xlarge | r7g.16xlarge | r7g.metal | c6in.metal | m6in.metal | m6idn.metal | r6in.metal | r6idn.metal | inf2.xlarge | inf2.8xlarge | inf2.24xlarge | inf2.48xlarge | trn1n.32xlarge | i4g.large | i4g.xlarge | i4g.2xlarge | i4g.4xlarge | i4g.8xlarge | i4g.16xlarge | hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge | c7gn.medium | c7gn.large | c7gn.xlarge | c7gn.2xlarge | c7gn.4xlarge | c7gn.8xlarge | c7gn.12xlarge | c7gn.16xlarge | p5.48xlarge | m7i.large | m7i.xlarge | m7i.2xlarge | m7i.4xlarge | m7i.8xlarge | m7i.12xlarge | m7i.16xlarge | m7i.24xlarge | m7i.48xlarge | m7i-flex.large | m7i-flex.xlarge | m7i-flex.2xlarge | m7i-flex.4xlarge | m7i-flex.8xlarge | m7a.medium | m7a.large | m7a.xlarge | m7a.2xlarge | m7a.4xlarge | m7a.8xlarge | m7a.12xlarge | m7a.16xlarge | m7a.24xlarge | m7a.32xlarge | m7a.48xlarge | m7a.metal-48xl | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge | c7gd.medium | c7gd.large | c7gd.xlarge | c7gd.2xlarge | c7gd.4xlarge | c7gd.8xlarge | c7gd.12xlarge | c7gd.16xlarge | m7gd.medium | m7gd.large | m7gd.xlarge | m7gd.2xlarge | m7gd.4xlarge | m7gd.8xlarge | m7gd.12xlarge | m7gd.16xlarge | r7gd.medium | r7gd.large | r7gd.xlarge | r7gd.2xlarge | r7gd.4xlarge | r7gd.8xlarge | r7gd.12xlarge | r7gd.16xlarge | r7a.medium | r7a.large | r7a.xlarge | r7a.2xlarge | r7a.4xlarge | r7a.8xlarge | r7a.12xlarge | r7a.16xlarge | r7a.24xlarge | r7a.32xlarge | r7a.48xlarge | c7i.large | c7i.xlarge | c7i.2xlarge | c7i.4xlarge | c7i.8xlarge | c7i.12xlarge | c7i.16xlarge | c7i.24xlarge | c7i.48xlarge | mac2-m2pro.metal | r7iz.large | r7iz.xlarge | r7iz.2xlarge | r7iz.4xlarge | r7iz.8xlarge | r7iz.12xlarge | r7iz.16xlarge | r7iz.32xlarge | c7a.medium | c7a.large | c7a.xlarge | c7a.2xlarge | c7a.4xlarge | c7a.8xlarge | c7a.12xlarge | c7a.16xlarge | c7a.24xlarge | c7a.32xlarge | c7a.48xlarge | c7a.metal-48xl | r7a.metal-48xl | r7i.large | r7i.xlarge | r7i.2xlarge | r7i.4xlarge | r7i.8xlarge | r7i.12xlarge | r7i.16xlarge | r7i.24xlarge | r7i.48xlarge | dl2q.24xlarge | mac2-m2.metal | i4i.12xlarge | i4i.24xlarge | c7i.metal-24xl | c7i.metal-48xl | m7i.metal-24xl | m7i.metal-48xl | r7i.metal-24xl | r7i.metal-48xl | r7iz.metal-16xl | r7iz.metal-32xl | c7gd.metal | m7gd.metal | r7gd.metal | g6.xlarge | g6.2xlarge | g6.4xlarge | g6.8xlarge | g6.12xlarge | g6.16xlarge | g6.24xlarge | g6.48xlarge | gr6.4xlarge | gr6.8xlarge | c7i-flex.large | c7i-flex.xlarge | c7i-flex.2xlarge | c7i-flex.4xlarge | c7i-flex.8xlarge | u7i-12tb.224xlarge | u7in-16tb.224xlarge | u7in-24tb.224xlarge | u7in-32tb.224xlarge | u7ib-12tb.224xlarge | c7gn.metal | r8g.medium | r8g.large | r8g.xlarge | r8g.2xlarge | r8g.4xlarge | r8g.8xlarge | r8g.12xlarge | r8g.16xlarge | r8g.24xlarge | r8g.48xlarge | r8g.metal-24xl | r8g.metal-48xl | mac2-m1ultra.metal | g6e.xlarge | g6e.2xlarge | g6e.4xlarge | g6e.8xlarge | g6e.12xlarge | g6e.16xlarge | g6e.24xlarge | g6e.48xlarge | c8g.medium | c8g.large | c8g.xlarge | c8g.2xlarge | c8g.4xlarge | c8g.8xlarge | c8g.12xlarge | c8g.16xlarge | c8g.24xlarge | c8g.48xlarge | c8g.metal-24xl | c8g.metal-48xl | m8g.medium | m8g.large | m8g.xlarge | m8g.2xlarge | m8g.4xlarge | m8g.8xlarge | m8g.12xlarge | m8g.16xlarge | m8g.24xlarge | m8g.48xlarge | m8g.metal-24xl | m8g.metal-48xl | x8g.medium | x8g.large | x8g.xlarge | x8g.2xlarge | x8g.4xlarge | x8g.8xlarge | x8g.12xlarge | x8g.16xlarge | x8g.24xlarge | x8g.48xlarge | x8g.metal-24xl | x8g.metal-48xl | i7ie.large | i7ie.xlarge | i7ie.2xlarge | i7ie.3xlarge | i7ie.6xlarge | i7ie.12xlarge | i7ie.18xlarge | i7ie.24xlarge | i7ie.48xlarge | i8g.large | i8g.xlarge | i8g.2xlarge | i8g.4xlarge | i8g.8xlarge | i8g.12xlarge | i8g.16xlarge | i8g.24xlarge | i8g.metal-24xl | u7i-6tb.112xlarge | u7i-8tb.112xlarge | u7inh-32tb.480xlarge | p5e.48xlarge | p5en.48xlarge | f2.12xlarge | f2.48xlarge | trn2.48xlarge | c7i-flex.12xlarge | c7i-flex.16xlarge | m7i-flex.12xlarge | m7i-flex.16xlarge | i7ie.metal-24xl | i7ie.metal-48xl | i8g.48xlarge | c8gd.medium | c8gd.large | c8gd.xlarge | c8gd.2xlarge | c8gd.4xlarge | c8gd.8xlarge | c8gd.12xlarge | c8gd.16xlarge | c8gd.24xlarge | c8gd.48xlarge | c8gd.metal-24xl | c8gd.metal-48xl | i7i.large | i7i.xlarge | i7i.2xlarge | i7i.4xlarge | i7i.8xlarge | i7i.12xlarge | i7i.16xlarge | i7i.24xlarge | i7i.48xlarge | i7i.metal-24xl | i7i.metal-48xl | p6-b200.48xlarge | m8gd.medium | m8gd.large | m8gd.xlarge | m8gd.2xlarge | m8gd.4xlarge | m8gd.8xlarge | m8gd.12xlarge | m8gd.16xlarge | m8gd.24xlarge | m8gd.48xlarge | m8gd.metal-24xl | m8gd.metal-48xl | r8gd.medium | r8gd.large | r8gd.xlarge | r8gd.2xlarge | r8gd.4xlarge | r8gd.8xlarge | r8gd.12xlarge | r8gd.16xlarge | r8gd.24xlarge | r8gd.48xlarge | r8gd.metal-24xl | r8gd.metal-48xl | c8gn.medium | c8gn.large | c8gn.xlarge | c8gn.2xlarge | c8gn.4xlarge | c8gn.8xlarge | c8gn.12xlarge | c8gn.16xlarge | c8gn.24xlarge | c8gn.48xlarge | c8gn.metal-24xl | c8gn.metal-48xl | f2.6xlarge | p6e-gb200.36xlarge | g6f.large | g6f.xlarge | g6f.2xlarge | g6f.4xlarge | gr6f.4xlarge | p5.4xlarge | r8i.large | r8i.xlarge | r8i.2xlarge | r8i.4xlarge | r8i.8xlarge | r8i.12xlarge | r8i.16xlarge | r8i.24xlarge | r8i.32xlarge | r8i.48xlarge | r8i.96xlarge | r8i.metal-48xl | r8i.metal-96xl | r8i-flex.large | r8i-flex.xlarge | r8i-flex.2xlarge | r8i-flex.4xlarge | r8i-flex.8xlarge | r8i-flex.12xlarge | r8i-flex.16xlarge` *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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](aws-properties-ec2-instance-instanceipv6address.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `KernelId` The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*. *Required*: No *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `KeyName` The name of the key pair. For more information, see [Create a key pair for your EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html). 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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](aws-properties-ec2-instance-launchtemplatespecification.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `LicenseSpecifications` The license configurations. *Required*: No *Type*: Array of [LicenseSpecification](aws-properties-ec2-instance-licensespecification.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MetadataOptions` The metadata options for the instance. *Required*: No *Type*: [MetadataOptions](aws-properties-ec2-instance-metadataoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *Amazon EC2 User Guide*. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NetworkInterfaces` The network interfaces to associate with the instance. 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the VPC-gateway attachment. *Required*: No *Type*: Array of [NetworkInterface](aws-properties-ec2-instance-networkinterface.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PlacementGroupName` The name of an existing placement group that you want to launch the instance into (cluster \$1 partition \$1 spread). *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PrivateDnsNameOptions` The options for the instance hostname. *Required*: No *Type*: [PrivateDnsNameOptions](aws-properties-ec2-instance-privatednsnameoptions.md) *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*. *Required*: No *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SsmAssociations` The SSM [ document](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html) 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-configuring-access-role.html) in the *AWS Systems Manager User Guide*. You can associate only one document with an instance. *Required*: No *Type*: Array of [SsmAssociation](aws-properties-ec2-instance-ssmassociation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-propagatetagstovolumeoncreation) is `true`. *Required*: No *Type*: Array of [Tag](aws-properties-ec2-instance-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-base64.html). 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `Volumes` The volumes to attach to the instance. *Required*: No *Type*: Array of [Volume](aws-properties-ec2-instance-volume.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## 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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### 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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `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 **Topics** + [EC2 instance with an EBS block device mapping](#aws-resource-ec2-instance--examples--EC2_instance_with_an_EBS_block_device_mapping) + [EC2 instance with user data](#aws-resource-ec2-instance--examples--EC2_instance_with_user_data) + [Launch an instance from a launch template](#aws-resource-ec2-instance--examples--Launch_an_instance_from_a_launch_template) + [Automatically assign a public IP address](#aws-resource-ec2-instance--examples--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" ``` ## See also + [ RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) in the *Amazon EC2 API Reference* + [ Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Instances.html) in the *Amazon EC2 User Guide* # AWS::EC2::Instance AssociationParameter Specifies input parameter values for an SSM document in AWS Systems Manager. `AssociationParameter` is a property of the [SsmAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociation.html) property type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-ec2-instance-associationparameter-key)" : String, "[Value](#cfn-ec2-instance-associationparameter-value)" : [ String, ... ] } ``` ### YAML ``` [Key](#cfn-ec2-instance-associationparameter-key): String [Value](#cfn-ec2-instance-associationparameter-value): - String ``` ## Properties `Key` The name of an input parameter that is in the associated SSM document. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of an input parameter. *Required*: Yes *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::EC2::Instance BlockDeviceMapping Specifies a block device mapping for an instance. You must specify exactly one of the following properties: `VirtualName`, `Ebs`, or `NoDevice`. `BlockDeviceMapping` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource. **Important** After the instance is running, you can modify only the `DeleteOnTermination` parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DeviceName](#cfn-ec2-instance-blockdevicemapping-devicename)" : String, "[Ebs](#cfn-ec2-instance-blockdevicemapping-ebs)" : Ebs, "[NoDevice](#cfn-ec2-instance-blockdevicemapping-nodevice)" : Json, "[VirtualName](#cfn-ec2-instance-blockdevicemapping-virtualname)" : String } ``` ### YAML ``` [DeviceName](#cfn-ec2-instance-blockdevicemapping-devicename): String [Ebs](#cfn-ec2-instance-blockdevicemapping-ebs): Ebs [NoDevice](#cfn-ec2-instance-blockdevicemapping-nodevice): Json [VirtualName](#cfn-ec2-instance-blockdevicemapping-virtualname): String ``` ## Properties `DeviceName` The device name. For available device names, see [Device names for volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html). After the instance is running, this parameter is used to specify the device name of the block device mapping to update. *Required*: Yes *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `Ebs` Parameters used to automatically set up EBS volumes when the instance is launched. After the instance is running, you can modify only the `DeleteOnTermination` parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). *Required*: Conditional *Type*: [Ebs](aws-properties-ec2-instance-ebs.md) *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `NoDevice` To omit the device from the block device mapping, specify an empty string. After the instance is running, modifying this parameter results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). *Required*: Conditional *Type*: Json *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `VirtualName` The virtual device name (`ephemeral`N). The name must be in the form `ephemeral`*X* where *X* is a number starting from zero (0). For example, an instance type with 2 available instance store volumes can specify mappings for `ephemeral0` and `ephemeral1`. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. *Constraints*: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. After the instance is running, modifying this parameter results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). *Required*: Conditional *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) ## Examples **Topics** + [Block device mapping with two EBS volumes](#aws-properties-ec2-instance-blockdevicemapping--examples--Block_device_mapping_with_two_EBS_volumes) + [Unmap an AMI-defined device](#aws-properties-ec2-instance-blockdevicemapping--examples--Unmap_an_AMI-defined_device) ### Block device mapping with two EBS volumes This example sets the size of an EBS-backed root device to 50 GiB and adds another EBS volume that is 100 GiB in size. The supported device names depend on the AMI for the instance. The volume names in this example are supported for Nitro-based Windows instances. #### JSON ``` "BlockDeviceMappings" : [ { "DeviceName" : "/dev/sda1", "Ebs" : { "VolumeSize" : "50" } }, { "DeviceName" : "xvdbm", "Ebs" : { "VolumeSize" : "100" } } ] ``` #### YAML ``` BlockDeviceMappings: - DeviceName: /dev/sda1 Ebs: VolumeSize: 50 - DeviceName: xvdbm Ebs: VolumeSize: 100 ``` ### Unmap an AMI-defined device To unmap a device defined in the AMI, set the `NoDevice` property to an empty map, as shown here: #### JSON ``` "BlockDeviceMappings" : [ { "DeviceName":"/dev/sde", "NoDevice": {} } ] ``` #### YAML ``` BlockDeviceMappings: - DeviceName: /dev/sde NoDevice: {} ``` ## See also + [ Block device mappings](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) in the *Amazon EC2 User Guide*. # AWS::EC2::Instance CpuOptions Specifies the CPU options for the instance. When you specify CPU options, you must specify both the number of CPU cores and threads per core. Modifying the CPU options for an instance results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide*. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CoreCount](#cfn-ec2-instance-cpuoptions-corecount)" : Integer, "[ThreadsPerCore](#cfn-ec2-instance-cpuoptions-threadspercore)" : Integer } ``` ### YAML ``` [CoreCount](#cfn-ec2-instance-cpuoptions-corecount): Integer [ThreadsPerCore](#cfn-ec2-instance-cpuoptions-threadspercore): Integer ``` ## Properties `CoreCount` The number of CPU cores for the instance. *Required*: No *Type*: Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ThreadsPerCore` The number of threads per CPU core. *Required*: No *Type*: Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::EC2::Instance CreditSpecification Specifies the credit option for CPU usage of a T instance. `CreditSpecification` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide*. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CPUCredits](#cfn-ec2-instance-creditspecification-cpucredits)" : String } ``` ### YAML ``` [CPUCredits](#cfn-ec2-instance-creditspecification-cpucredits): String ``` ## Properties `CPUCredits` The credit option for CPU usage of the instance. Valid values: `standard` \$1 `unlimited` T3 instances with `host` tenancy do not support the `unlimited` CPU credit option. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::EC2::Instance Ebs Specifies a block device for an EBS volume. `Ebs` is a property of the [ BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html) property type. **Important** After the instance is running, you can modify only the `DeleteOnTermination` parameters for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DeleteOnTermination](#cfn-ec2-instance-ebs-deleteontermination)" : Boolean, "[Encrypted](#cfn-ec2-instance-ebs-encrypted)" : Boolean, "[Iops](#cfn-ec2-instance-ebs-iops)" : Integer, "[KmsKeyId](#cfn-ec2-instance-ebs-kmskeyid)" : String, "[SnapshotId](#cfn-ec2-instance-ebs-snapshotid)" : String, "[VolumeSize](#cfn-ec2-instance-ebs-volumesize)" : Integer, "[VolumeType](#cfn-ec2-instance-ebs-volumetype)" : String } ``` ### YAML ``` [DeleteOnTermination](#cfn-ec2-instance-ebs-deleteontermination): Boolean [Encrypted](#cfn-ec2-instance-ebs-encrypted): Boolean [Iops](#cfn-ec2-instance-ebs-iops): Integer [KmsKeyId](#cfn-ec2-instance-ebs-kmskeyid): String [SnapshotId](#cfn-ec2-instance-ebs-snapshotid): String [VolumeSize](#cfn-ec2-instance-ebs-volumesize): Integer [VolumeType](#cfn-ec2-instance-ebs-volumetype): String ``` ## Properties `DeleteOnTermination` Indicates whether the EBS volume is deleted on instance termination. For more information, see [Preserving Amazon EBS volumes on instance termination](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) in the *Amazon EC2 User Guide*. *Required*: No *Type*: Boolean *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `Encrypted` Indicates whether the volume should be encrypted. The effect of setting the encryption state to `true` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). After the instance is running, modifying this parameter results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). *Required*: No *Type*: Boolean *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `Iops` The number of I/O operations per second (IOPS). For `gp3`, `io1`, and `io2` volumes, this represents the number of IOPS that are provisioned for the volume. For `gp2` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: + `gp3`: 3,000-16,000 IOPS + `io1`: 100-64,000 IOPS + `io2`: 100-64,000 IOPS For `io1` and `io2` volumes, we guarantee 64,000 IOPS only for [Instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). Other instance families guarantee performance up to 32,000 IOPS. This parameter is required for `io1` and `io2` volumes. The default for `gp3` volumes is 3,000 IOPS. This parameter is not supported for `gp2`, `st1`, `sc1`, or `standard` volumes. After the instance is running, modifying this parameter results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). *Required*: Conditional *Type*: Integer *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `KmsKeyId` The identifier of the AWS KMS key to use for Amazon EBS encryption. If `KmsKeyId` is specified, the encrypted state must be `true`. If the encrypted state is `true` but you do not specify `KmsKeyId`, your KMS key for EBS is used. You can specify the KMS key using any of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. For example, alias/ExampleAlias. + Key ARN. For example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias. After the instance is running, modifying this parameter results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). *Required*: No *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `SnapshotId` The ID of the snapshot. If you specify both `SnapshotId` and `VolumeSize`, `VolumeSize` must be equal or greater than the size of the snapshot. After the instance is running, modifying this parameter results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). *Required*: Conditional *Type*: String *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `VolumeSize` The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported volumes sizes for each volume type: + `gp2` and `gp3`:1-16,384 + `io1` and `io2`: 4-16,384 + `st1` and `sc1`: 125-16,384 + `standard`: 1-1,024 After the instance is running, modifying this parameter results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). *Required*: Conditional *Type*: Integer *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `VolumeType` The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide*. If the volume type is `io1` or `io2`, you must specify the IOPS that the volume supports. After the instance is running, modifying this parameter results in instance [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). *Required*: No *Type*: String *Allowed values*: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3` *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) ## Examples ### Create an EBS volume from a snapshot This example creates a 50GB io1 EBS volume from a snapshot, and configures it to support 1000 IOPS and to persist after terminating the instance to which it is attached. #### JSON ``` { "DeviceName": "/dev/sdc", "Ebs": { "SnapshotId": "snap-xxxxxxxx", "VolumeSize": "50", "VolumeType": "io1", "Iops": "1000", "DeleteOnTermination": "false" } } ``` #### YAML ``` BlockDeviceMappings: - DeviceName: /dev/sdc Ebs: SnapshotId: snap-xxxxxxxx VolumeSize: 50 VolumeType: io1 Iops: 1000 DeleteOnTermination: false ``` ## See also + [ CreateVolume](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* # AWS::EC2::Instance ElasticGpuSpecification **Note** Amazon Elastic Graphics reached end of life on January 8, 2024. Specifies the type of Elastic GPU. An Elastic GPU is a GPU resource that you can attach to your Amazon EC2 instance to accelerate the graphics performance of your applications. `ElasticGpuSpecification` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Type](#cfn-ec2-instance-elasticgpuspecification-type)" : String } ``` ### YAML ``` [Type](#cfn-ec2-instance-elasticgpuspecification-type): String ``` ## Properties `Type` The type of Elastic Graphics accelerator. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::EC2::Instance ElasticInferenceAccelerator **Note** Amazon Elastic Inference is no longer available. Specifies the Elastic Inference Accelerator for the instance. `ElasticInferenceAccelerator` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Count](#cfn-ec2-instance-elasticinferenceaccelerator-count)" : Integer, "[Type](#cfn-ec2-instance-elasticinferenceaccelerator-type)" : String } ``` ### YAML ``` [Count](#cfn-ec2-instance-elasticinferenceaccelerator-count): Integer [Type](#cfn-ec2-instance-elasticinferenceaccelerator-type): String ``` ## Properties `Count` The number of elastic inference accelerators to attach to the instance. *Required*: No *Type*: Integer *Minimum*: `0` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Type` The type of elastic inference accelerator. The possible values are `eia1.medium`, `eia1.large`, `eia1.xlarge`, `eia2.medium`, `eia2.large`, and `eia2.xlarge`. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::EC2::Instance EnaSrdSpecification ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled. To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EnaSrdEnabled](#cfn-ec2-instance-enasrdspecification-enasrdenabled)" : Boolean, "[EnaSrdUdpSpecification](#cfn-ec2-instance-enasrdspecification-enasrdudpspecification)" : EnaSrdUdpSpecification } ``` ### YAML ``` [EnaSrdEnabled](#cfn-ec2-instance-enasrdspecification-enasrdenabled): Boolean [EnaSrdUdpSpecification](#cfn-ec2-instance-enasrdspecification-enasrdudpspecification): EnaSrdUdpSpecification ``` ## Properties `EnaSrdEnabled` Indicates whether ENA Express is enabled for the network interface. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnaSrdUdpSpecification` Configures ENA Express for UDP network traffic. *Required*: No *Type*: [EnaSrdUdpSpecification](aws-properties-ec2-instance-enasrdudpspecification.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::EC2::Instance EnaSrdUdpSpecification ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EnaSrdUdpEnabled](#cfn-ec2-instance-enasrdudpspecification-enasrdudpenabled)" : Boolean } ``` ### YAML ``` [EnaSrdUdpEnabled](#cfn-ec2-instance-enasrdudpspecification-enasrdudpenabled): Boolean ``` ## Properties `EnaSrdUdpEnabled` Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::EC2::Instance EnclaveOptions Indicates whether the instance is enabled for AWS Nitro Enclaves. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Enabled](#cfn-ec2-instance-enclaveoptions-enabled)" : Boolean } ``` ### YAML ``` [Enabled](#cfn-ec2-instance-enclaveoptions-enabled): Boolean ``` ## Properties `Enabled` If this parameter is set to `true`, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::EC2::Instance HibernationOptions Specifies the hibernation options for the instance. `HibernationOptions` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Configured](#cfn-ec2-instance-hibernationoptions-configured)" : Boolean } ``` ### YAML ``` [Configured](#cfn-ec2-instance-hibernationoptions-configured): Boolean ``` ## Properties `Configured` Set to `true` to enable your instance for hibernation. For Spot Instances, if you set `Configured` to `true`, either omit the `InstanceInterruptionBehavior` parameter (for [https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotMarketOptions.html](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotMarketOptions.html)), or set it to `hibernate`. When `Configured` is true: + If you omit `InstanceInterruptionBehavior`, it defaults to `hibernate`. + If you set `InstanceInterruptionBehavior` to a value other than `hibernate`, you'll get an error. Default: `false` *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::EC2::Instance InstanceIpv6Address Specifies the IPv6 address for the instance. `InstanceIpv6Address` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Ipv6Address](#cfn-ec2-instance-instanceipv6address-ipv6address)" : String } ``` ### YAML ``` [Ipv6Address](#cfn-ec2-instance-instanceipv6address-ipv6address): String ``` ## Properties `Ipv6Address` The IPv6 address. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::EC2::Instance LaunchTemplateSpecification Specifies a launch template to use when launching an Amazon EC2 instance. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) in the *Amazon EC2 User Guide*. For example launch templates, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) for `AWS::EC2::LaunchTemplate`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LaunchTemplateId](#cfn-ec2-instance-launchtemplatespecification-launchtemplateid)" : String, "[LaunchTemplateName](#cfn-ec2-instance-launchtemplatespecification-launchtemplatename)" : String, "[Version](#cfn-ec2-instance-launchtemplatespecification-version)" : String } ``` ### YAML ``` [LaunchTemplateId](#cfn-ec2-instance-launchtemplatespecification-launchtemplateid): String [LaunchTemplateName](#cfn-ec2-instance-launchtemplatespecification-launchtemplatename): String [Version](#cfn-ec2-instance-launchtemplatespecification-version): String ``` ## Properties `LaunchTemplateId` The ID of the launch template. You must specify either the launch template ID or the launch template name, but not both. *Required*: Conditional *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `LaunchTemplateName` The name of the launch template. You must specify either the launch template ID or the launch template name, but not both. *Required*: Conditional *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Version` The version number of the launch template. You must specify this property. To specify the default version of the template, use the `Fn::GetAtt` intrinsic function to retrieve the `DefaultVersionNumber` attribute of the launch template. To specify the latest version of the template, use `Fn::GetAtt` to retrieve the `LatestVersionNumber` attribute. For more information, see [AWS::EC2:LaunchTemplate return values for Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate-return-values-fn--getatt). *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Examples ### Launch an instance using a launch template This example creates a launch template and uses it to launch a new instance. #### 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 SecurityGroupIds: - sg-12a4c434 ``` ## See also + [ LaunchTemplateSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateSpecification.html) in the *Amazon EC2 API Reference* # AWS::EC2::Instance LicenseSpecification Specifies the license configuration to use. `LicenseSpecification` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LicenseConfigurationArn](#cfn-ec2-instance-licensespecification-licenseconfigurationarn)" : String } ``` ### YAML ``` [LicenseConfigurationArn](#cfn-ec2-instance-licensespecification-licenseconfigurationarn): String ``` ## Properties `LicenseConfigurationArn` The Amazon Resource Name (ARN) of the license configuration. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::EC2::Instance MetadataOptions Specifies the metadata options for the instance. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[HttpEndpoint](#cfn-ec2-instance-metadataoptions-httpendpoint)" : String, "[HttpProtocolIpv6](#cfn-ec2-instance-metadataoptions-httpprotocolipv6)" : String, "[HttpPutResponseHopLimit](#cfn-ec2-instance-metadataoptions-httpputresponsehoplimit)" : Integer, "[HttpTokens](#cfn-ec2-instance-metadataoptions-httptokens)" : String, "[InstanceMetadataTags](#cfn-ec2-instance-metadataoptions-instancemetadatatags)" : String } ``` ### YAML ``` [HttpEndpoint](#cfn-ec2-instance-metadataoptions-httpendpoint): String [HttpProtocolIpv6](#cfn-ec2-instance-metadataoptions-httpprotocolipv6): String [HttpPutResponseHopLimit](#cfn-ec2-instance-metadataoptions-httpputresponsehoplimit): Integer [HttpTokens](#cfn-ec2-instance-metadataoptions-httptokens): String [InstanceMetadataTags](#cfn-ec2-instance-metadataoptions-instancemetadatatags): String ``` ## Properties `HttpEndpoint` Enables or disables the HTTP metadata endpoint on your instances. If you specify a value of `disabled`, you cannot access your instance metadata. Default: `enabled` *Required*: No *Type*: String *Allowed values*: `disabled | enabled` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HttpProtocolIpv6` Enables or disables the IPv6 endpoint for the instance metadata service. Default: `disabled` *Required*: No *Type*: String *Allowed values*: `disabled | enabled` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HttpPutResponseHopLimit` The maximum number of hops that the metadata token can travel. Possible values: Integers from 1 to 64 *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HttpTokens` Indicates whether IMDSv2 is required. + `optional` - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. + `required` - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2. Default: + If the value of `ImdsSupport` for the Amazon Machine Image (AMI) for your instance is `v2.0` and the account level default is set to `no-preference`, the default is `required`. + If the value of `ImdsSupport` for the Amazon Machine Image (AMI) for your instance is `v2.0`, but the account level default is set to `V1 or V2`, the default is `optional`. The default value can also be affected by other combinations of parameters. For more information, see [Order of precedence for instance metadata options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence) in the *Amazon EC2 User Guide*. *Required*: No *Type*: String *Allowed values*: `optional | required` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InstanceMetadataTags` Set to `enabled` to allow access to instance tags from the instance metadata. Set to `disabled` to turn off access to instance tags from the instance metadata. For more information, see [View tags for your EC2 instances using instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-tags-in-IMDS.html). Default: `disabled` *Required*: No *Type*: String *Allowed values*: `disabled | enabled` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::EC2::Instance NetworkInterface Specifies a network interface that is to be attached to an instance. You can create a network interface when launching an instance. For an example, see the [AWS::EC2::Instance examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#aws-properties-ec2-instance--examples--Automatically_assign_a_public_IP_address). Alternatively, you can attach an existing network interface when launching an instance. For an example, see the [AWS::EC2:NetworkInterface examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#aws-resource-ec2-networkinterface--examples). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AssociateCarrierIpAddress](#cfn-ec2-instance-networkinterface-associatecarrieripaddress)" : Boolean, "[AssociatePublicIpAddress](#cfn-ec2-instance-networkinterface-associatepublicipaddress)" : Boolean, "[DeleteOnTermination](#cfn-ec2-instance-networkinterface-deleteontermination)" : Boolean, "[Description](#cfn-ec2-instance-networkinterface-description)" : String, "[DeviceIndex](#cfn-ec2-instance-networkinterface-deviceindex)" : String, "[EnaSrdSpecification](#cfn-ec2-instance-networkinterface-enasrdspecification)" : EnaSrdSpecification, "[GroupSet](#cfn-ec2-instance-networkinterface-groupset)" : [ String, ... ], "[Ipv6AddressCount](#cfn-ec2-instance-networkinterface-ipv6addresscount)" : Integer, "[Ipv6Addresses](#cfn-ec2-instance-networkinterface-ipv6addresses)" : [ InstanceIpv6Address, ... ], "[NetworkInterfaceId](#cfn-ec2-instance-networkinterface-networkinterfaceid)" : String, "[PrivateIpAddress](#cfn-ec2-instance-networkinterface-privateipaddress)" : String, "[PrivateIpAddresses](#cfn-ec2-instance-networkinterface-privateipaddresses)" : [ PrivateIpAddressSpecification, ... ], "[SecondaryPrivateIpAddressCount](#cfn-ec2-instance-networkinterface-secondaryprivateipaddresscount)" : Integer, "[SubnetId](#cfn-ec2-instance-networkinterface-subnetid)" : String } ``` ### YAML ``` [AssociateCarrierIpAddress](#cfn-ec2-instance-networkinterface-associatecarrieripaddress): Boolean [AssociatePublicIpAddress](#cfn-ec2-instance-networkinterface-associatepublicipaddress): Boolean [DeleteOnTermination](#cfn-ec2-instance-networkinterface-deleteontermination): Boolean [Description](#cfn-ec2-instance-networkinterface-description): String [DeviceIndex](#cfn-ec2-instance-networkinterface-deviceindex): String [EnaSrdSpecification](#cfn-ec2-instance-networkinterface-enasrdspecification): EnaSrdSpecification [GroupSet](#cfn-ec2-instance-networkinterface-groupset): - String [Ipv6AddressCount](#cfn-ec2-instance-networkinterface-ipv6addresscount): Integer [Ipv6Addresses](#cfn-ec2-instance-networkinterface-ipv6addresses): - InstanceIpv6Address [NetworkInterfaceId](#cfn-ec2-instance-networkinterface-networkinterfaceid): String [PrivateIpAddress](#cfn-ec2-instance-networkinterface-privateipaddress): String [PrivateIpAddresses](#cfn-ec2-instance-networkinterface-privateipaddresses): - PrivateIpAddressSpecification [SecondaryPrivateIpAddressCount](#cfn-ec2-instance-networkinterface-secondaryprivateipaddresscount): Integer [SubnetId](#cfn-ec2-instance-networkinterface-subnetid): String ``` ## Properties `AssociateCarrierIpAddress` Indicates whether to assign a carrier IP address to the network interface. You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see [Carrier IP address](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *AWS Wavelength Developer Guide*. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `AssociatePublicIpAddress` Indicates whether to assign a public IPv4 address to an instance. Applies only if creating a network interface when launching an instance. The network interface must be the primary network interface. If launching into a default subnet, the default value is `true`. AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://aws.amazon.com/vpc/pricing/). *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DeleteOnTermination` Indicates whether the network interface is deleted when the instance is terminated. Applies only if creating a network interface when launching an instance. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Description` The description of the network interface. Applies only if creating a network interface when launching an instance. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DeviceIndex` The position of the network interface in the attachment order. A primary network interface has a device index of 0. If you create a network interface when launching an instance, you must specify the device index. *Required*: Conditional *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnaSrdSpecification` Configures ENA Express for UDP network traffic. *Required*: No *Type*: [EnaSrdSpecification](aws-properties-ec2-instance-enasrdspecification.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `GroupSet` The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. *Required*: No *Type*: Array of String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Ipv6AddressCount` A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the 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. *Required*: No *Type*: Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Ipv6Addresses` The IPv6 addresses to assign to the 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. *Required*: No *Type*: Array of [InstanceIpv6Address](aws-properties-ec2-instance-instanceipv6address.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `NetworkInterfaceId` The ID of the network interface, when attaching an existing network interface. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PrivateIpAddress` The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PrivateIpAddresses` One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. *Required*: No *Type*: Array of [PrivateIpAddressSpecification](aws-properties-ec2-instance-privateipaddressspecification.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SecondaryPrivateIpAddressCount` The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. *Required*: No *Type*: Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SubnetId` The ID of the subnet associated with the network interface. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::EC2::Instance PrivateDnsNameOptions The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide*. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EnableResourceNameDnsAAAARecord](#cfn-ec2-instance-privatednsnameoptions-enableresourcenamednsaaaarecord)" : Boolean, "[EnableResourceNameDnsARecord](#cfn-ec2-instance-privatednsnameoptions-enableresourcenamednsarecord)" : Boolean, "[HostnameType](#cfn-ec2-instance-privatednsnameoptions-hostnametype)" : String } ``` ### YAML ``` [EnableResourceNameDnsAAAARecord](#cfn-ec2-instance-privatednsnameoptions-enableresourcenamednsaaaarecord): Boolean [EnableResourceNameDnsARecord](#cfn-ec2-instance-privatednsnameoptions-enableresourcenamednsarecord): Boolean [HostnameType](#cfn-ec2-instance-privatednsnameoptions-hostnametype): String ``` ## Properties `EnableResourceNameDnsAAAARecord` Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide*. *Required*: No *Type*: Boolean *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `EnableResourceNameDnsARecord` Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide*. *Required*: No *Type*: Boolean *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `HostnameType` The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide*. *Required*: No *Type*: String *Allowed values*: `ip-name | resource-name` *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) # AWS::EC2::Instance PrivateIpAddressSpecification Specifies a secondary private IPv4 address for a network interface. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Primary](#cfn-ec2-instance-privateipaddressspecification-primary)" : Boolean, "[PrivateIpAddress](#cfn-ec2-instance-privateipaddressspecification-privateipaddress)" : String } ``` ### YAML ``` [Primary](#cfn-ec2-instance-privateipaddressspecification-primary): Boolean [PrivateIpAddress](#cfn-ec2-instance-privateipaddressspecification-privateipaddress): String ``` ## Properties `Primary` Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PrivateIpAddress` The private IPv4 address. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::EC2::Instance SsmAssociation Specifies the SSM document and parameter values in AWS Systems Manager to associate with an instance. `SsmAssociations` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AssociationParameters](#cfn-ec2-instance-ssmassociation-associationparameters)" : [ AssociationParameter, ... ], "[DocumentName](#cfn-ec2-instance-ssmassociation-documentname)" : String } ``` ### YAML ``` [AssociationParameters](#cfn-ec2-instance-ssmassociation-associationparameters): - AssociationParameter [DocumentName](#cfn-ec2-instance-ssmassociation-documentname): String ``` ## Properties `AssociationParameters` The input parameter values to use with the associated SSM document. *Required*: No *Type*: Array of [AssociationParameter](aws-properties-ec2-instance-associationparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DocumentName` The name of an SSM document to associate with the instance. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::EC2::Instance State Describes the current state of an instance. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Code](#cfn-ec2-instance-state-code)" : String, "[Name](#cfn-ec2-instance-state-name)" : String } ``` ### YAML ``` [Code](#cfn-ec2-instance-state-code): String [Name](#cfn-ec2-instance-state-name): String ``` ## Properties `Code` The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: + `0` : `pending` + `16` : `running` + `32` : `shutting-down` + `48` : `terminated` + `64` : `stopping` + `80` : `stopped` You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The current state of the instance. *Required*: No *Type*: String *Allowed values*: `pending | running | shutting-down | terminated | stopping | stopped` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::EC2::Instance Tag Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-ec2-instance-tag-key)" : String, "[Value](#cfn-ec2-instance-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-ec2-instance-tag-key): String [Value](#cfn-ec2-instance-tag-value): String ``` ## Properties `Key` The tag key. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The tag value. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Examples ### This example specifies two tags for the instance. #### JSON ``` "Tags" : [ { "Key" : "key1", "Value" : "value1" }, { "Key" : "key2", "Value" : "value2" } ] ``` #### YAML ``` Tags: - Key: "key1" Value: "value1" - Key: "key2" Value: "value2" ``` # AWS::EC2::Instance Volume Specifies a volume to attach to an instance. `Volume` is an embedded property of the [ AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Device](#cfn-ec2-instance-volume-device)" : String, "[VolumeId](#cfn-ec2-instance-volume-volumeid)" : String } ``` ### YAML ``` [Device](#cfn-ec2-instance-volume-device): String [VolumeId](#cfn-ec2-instance-volume-volumeid): String ``` ## Properties `Device` The device name (for example, `/dev/sdh` or `xvdh`). *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `VolumeId` The ID of the EBS volume. The volume and instance must be within the same Availability Zone. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)