Affinity |
String
|
Required: No. Indicates whether Amazon Elastic Compute Cloud (Amazon EC2) always associates the instance with a dedicated host. If you want Amazon EC2 to always restart the instance (if it was stopped) onto the same host on which it was launched, specify host. If you want Amazon EC2 to restart the instance on any available host, but to try to launch the instance onto the last host it ran on (on a best-effort basis), specify default.Update requires: No interruption |
AvailabilityZone |
String
|
Required: Conditional. Specifies the name of the Availability Zone in which the instance is
located.For more information about AWS regions and Availability Zones, see Regions and Availability Zones in the Amazon EC2 User
Guide.Update requires: Replacement |
BlockDeviceMappings |
AmazonEC2BlockDeviceMappingProperty
|
Required: No. Defines a set of Amazon Elastic Block Store block device mappings, ephemeral instance store
block device mappings, or both. For more information, see Amazon Elastic Block Store or Amazon EC2 Instance Store in the
Amazon EC2 User Guide for Linux Instances.Update requires: Replacement. If you change only the DeleteOnTermination
property for one or more block devices, update requires No interruption. |
DisableApiTermination |
Boolean
|
Required: No. Specifies whether the instance can be terminated through the API.Update requires: No interruption |
EbsOptimized |
Boolean
|
Required: Conditional. Specifies whether the instance is optimized for Amazon Elastic Block Store I/O. This
optimization provides dedicated throughput to Amazon EBS and an optimized configuration
stack to provide optimal EBS I/O performance.For more information about the instance types that can be launched as Amazon EBS
optimized instances, see Amazon
EBS-Optimized Instances in the Amazon Elastic Compute Cloud
User Guide. Additional fees are incurred when using Amazon EBS-optimized
instances.Update requires:Update requires: Some interruptions for Amazon EBS-backed instancesUpdate requires: Replacement for instance store-backed instances |
HostId |
String
|
Required: No. 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.Update requires: No interruption |
IamInstanceProfile |
String
|
Required: No. The physical ID (resource name) of an instance profile or a reference to an
AWS::IAM::InstanceProfile resource.For more information about IAM roles, see Working with Roles in the
AWS Identity and Access Management User Guide.Update requires: Replacement |
ImageId |
String
|
Required: Yes. Provides the unique ID of the Amazon Machine Image (AMI) that was assigned
during registration.Update requires: Replacement |
InstanceInitiatedShutdownBehavior |
String
|
Required: No. Indicates whether an instance stops or terminates when you shut down the
instance from the instance's operating system shutdown command. You can specify
stop or terminate. For more information, see the
RunInstances command in the
Amazon EC2 API Reference.Update requires: No interruption |
InstanceType |
String
|
Required: No. The instance type, such as t2.micro. The default type is
"m1.small". For a list of instance types, see Instance Families and
Types.Update requires:Update requires: Some interruptions for Amazon EBS-backed instancesUpdate requires: Replacement for instance store-backed instances |
KernelId |
String
|
Required: No. The kernel ID.Update requires:Update requires: Some interruptions for Amazon EBS-backed instancesUpdate requires: Replacement for instance store-backed instances |
KeyName |
String
|
Required: No. Provides the name of the Amazon EC2 key pair.Update requires: Replacement |
Monitoring |
Boolean
|
Required: No. Specifies whether monitoring is enabled for the instance.Update requires: No interruption |
NetworkInterfaces |
EC2NetworkInterfaceEmbeddedPropertyType
|
Required: No. A list of embedded objects that describe the network interfaces to associate
with this instance.NoteIf this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the
DependsOn attribute to declare a dependency on the VPC-gateway attachment. For more information,
see DependsOn Attribute.Update requires: Replacement |
PlacementGroupName |
String
|
Required: No. The name of an existing placement group that you want to launch the instance
into (for cluster instances).Update requires: Replacement |
PrivateIpAddress |
String
|
Required: No. The private IP address for this instance.ImportantIf 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
in order to roll back the stack to the previous working state. The old and
new instances cannot have the same private IP address.(Optional) If you're using Amazon VPC, you can use this parameter to assign the
instance a specific available IP address from the subnet (for example, 10.0.0.25).
By default, Amazon VPC selects an IP address from the subnet for the instance.Update requires: Replacement |
RamdiskId |
String
|
Required: No. 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.Update requires:Update requires: Some interruptions for Amazon EBS-backed instancesUpdate requires: Replacement for instance store-backed instances |
SecurityGroupIds |
String
|
Required: Conditional. A list that contains the security group IDs for VPC security groups to assign
to the Amazon EC2 instance. If you specified the NetworkInterfaces
property, do not specify this property.Update requires:Update requires: No interruption for instances that are in a VPC.Update requires: Replacement for instances that are not in a VPC. |
SecurityGroups |
String
|
Required: No. Valid only for Amazon EC2 security groups. A list that contains the Amazon EC2 security
groups to assign to the Amazon EC2 instance. The list can contain both the name of
existing Amazon EC2 security groups or references to AWS::EC2::SecurityGroup resources
created in the template.Update requires: Replacement. |
SourceDestCheck |
Boolean
|
Required: No. Controls whether source/destination checking is enabled on the instance. Also
determines if an instance in a VPC will perform network address translation
(NAT).A value of "true" means that source/destination checking is
enabled, and a value of "false" means that checking is disabled. For
the instance to perform NAT, the value must be
"false". For more information, see NAT
Instances in the Amazon Virtual Private Cloud User
Guide.Update requires: No interruption |
SsmAssociations |
AmazonEC2InstanceSsmAssociations
|
Required: No. The Amazon EC2 Simple Systems Manager (SSM) document
and parameter values to associate with this instance. To use this property, you
must specify an IAM role for the instance. For more information, see Prerequisites for Remotely
Running Commands on EC2 Instances in the
Amazon EC2 User Guide for Microsoft Windows Instances.NoteYou can currently associate only one document with an instance.Update requires: No interruption |
SubnetId |
String
|
Required: No. If you're using Amazon VPC, this property specifies the ID of the subnet that
you want to launch the instance into. If you specified the
NetworkInterfaces property, do not specify this property.Update requires: Replacement |
Tags |
AWSCloudFormationResourceTags
|
Required: No. An arbitrary set of tags (key–value pairs) for this instance.Update requires: No interruption. |
Tenancy |
String
|
Required: No. The tenancy of the instance that you want to launch, such as default, dedicated, or host. If you specify a tenancy value of dedicated or host, you must launch the instance in a VPC. For more information, see Dedicated Instances in the Amazon VPC User Guide.Update requires:Update requires: No interruption if this property was set to dedicated and you change it to host or vice versa.Update requires: Replacement for all other changes. |
UserData |
String
|
Required: No. Base64-encoded MIME user data that is made available to the instances.Update requires:Update requires: Some interruptions for Amazon EBS-backed instances.NoteFor EBS-backed instances, changing the UserData stops
and then starts the instance; however, Amazon EC2 doesn't automatically run
the updated UserData. To update configurations on your
instance, use the cfn-hup helper
script.Update requires: Replacement for instance store-backed instances. |
Volumes |
EC2MountPointPropertyType
|
Required: No. The Amazon EBS volumes to attach to the instance.NoteBefore detaching a volume, unmount any file systems on the device within
your operating system. If you don't unmount the file system, a volume might
get stuck in a busy state while detaching.Update requires: No interruption |
AdditionalInfo |
String
|
Required: No. Reserved.Update requires:
Update requires: Some interruptions for Amazon EBS-backed instancesUpdate requires: Replacement for instance store-backed instances |