AWS::EC2::Instance

2024-12-07 AdditionalInfo This property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this

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).

require: No

type: string

Update is requires require: Some interruption

affinity

Indicates whether the instance is associated with a dedicate 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 run on ( on a good – effort basis ) , specify
default.

require: No

type: string

allow value: default | host

Update is requires require: Some interruption

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 support by DescribeImageAttribute .

require: No

type: string

Update is requires require: 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 volume without
interrupt the instance . modify any other parameter result in instance replacement .

require: No

type: Array of BlockDeviceMapping

Update is requires require: Some interruption

CpuOptions

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

require: No

type: cpuoption

Update is requires require: replacement

CreditSpecification

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

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

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

require: No

type: CreditSpecification

Update is requires require: No interruption

DisableApiTermination

If you set this parameter to true, you can’t terminate the instance using
the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after
launch, use ModifyInstanceAttribute. Alternatively, if you set
InstanceInitiatedShutdownBehavior to terminate, you is terminate can
terminate the instance by run the shutdown command from the instance .

default :false

require: No

type: boolean

Update is requires require: No interruption

ebsoptimize

indicate whether the instance is optimize for Amazon EBS I / O. This optimization is provides
provide dedicate throughput to Amazon EBS and an optimize configuration stack to
provide optimal Amazon EBS I / o performance . This optimization is is is n’t available with all
instance type . additional usage charges is apply apply when using an EBS – optimize
instance .

default :false

require: No

type: boolean

Update is requires require: Some interruption

ElasticGpuSpecifications

An elastic GPU to associate with the instance.

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

require: No

type: Array of ElasticGpuSpecification

Update is requires require: replacement

ElasticInferenceAccelerators

An elastic inference accelerator to associate with the instance .

Amazon Elastic Inference is no longer available.

require: No

type: Array of ElasticInferenceAccelerator

Update is requires require: replacement

EnclaveOptions

indicate whether the instance is enable for AWS Nitro
enclave .

require: No

type: EnclaveOptions

Update is requires require: replacement

HibernationOptions

indicate whether an instance is enable for hibernation . This parameter is is is valid only
if the instance meet the hibernation
prerequisite . For more information , see hibernate your Amazon EC2
instance in theAmazon EC2 User Guide.

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

require: No

type: HibernationOptions

Update is requires require: replacement

HostId

If you specify host for the affinity property , the ID of a dedicate host
that the instance is associate with . If you do n’t specify an ID , Amazon EC2 is launches launch the
instance onto any available , compatible dedicate host in your account . This type of launch
is call an untargeted launch . note that for untargeted launch , you must have a
compatible , dedicate host available to successfully launch instance .

require: No

type: string

Update is requires require: Some interruption

HostResourceGroupArn

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

require: No

type: string

Update is requires require: replacement

iaminstanceprofile

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

require: No

type: string

Update is requires require: No interruption

ImageId

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

require: Conditional

type: string

Update is requires require: 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

require: No

type: string

allow value: stop | terminate

Update is requires require: No interruption

Instancetype

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

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

require: No

type: string

Update is requires require: Some interruption

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 is specify can not specify this option and the network interface option in the same
request .

require: No

type: Integer

Update is requires require: replacement

ipv6addresse

The IPv6 is addresses address from the range of the subnet to associate with the
primary network interface . You is specify can not specify this option and the option to assign a
number of IPv6 address in the same request . You is specify can not specify this option if you ‘ve
specify a minimum number of instance to launch .

You is specify can not specify this option and the network interface option in the same
request .

require: No

type: Array of InstanceIpv6Address

Update is requires require: 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 in the
Amazon EC2 User Guide.

require: No

type: string

Update is requires require: Some interruption

KeyName

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

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.

require: No

type: string

Update is requires require: replacement

LaunchTemplate

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

require: No

type: LaunchTemplateSpecification

Update is requires require: replacement

LicenseSpecifications

The license configurations.

require: No

type: Array of LicenseSpecification

Update is requires require: replacement

Monitoring

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

require: No

type: boolean

Update is requires require: No interruption

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 define in the
same template , you is use must use the DependsOn
Attribute to declare a dependency on the vpc – gateway attachment .

require: No

type: Array of NetworkInterface

Update is requires require: replacement

PlacementGroupName

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

require: No

type: string

Update is requires require: replacement

PrivateDnsNameOptions

The options for the instance hostname.

require: No

type: PrivateDnsNameOptions

Update is requires require: Some interruption

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.

require: No

type: string

Update is requires require: replacement

PropagateTagsToVolumeOnCreation

Indicates whether to assign the tags from the instance to all of the volumes attached to
the instance at launch. If you specify true and you assign tags to the
instance, those tags are automatically assigned to all of the volumes that you attach to
the instance at launch. If you specify false, those tags are not assigned to
the attached volumes.

require: No

type: boolean

Update is requires require: No interruption

RamdiskId

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

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

require: No

type: string

Update is requires require: Some interruption

SecurityGroupIds

The id of the security group . You is specify can specify the id of exist security group and
reference to resource create by the stack template .

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

require: Conditional

type: Array of string

Update is requires require: Some interruption

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.

require: No

type: Array of string

Update is requires require: replacement

SourceDestCheck

enable or disable source / destination check , which ensure that the instance
is either the source or the destination of any traffic that it receive .
If the value is is istrue, 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.

require: No

type: boolean

Update is requires require: No interruption

SsmAssociations

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

You can associate only one document with an instance.

require: No

type: Array of SsmAssociation

Update is requires require: No interruption

SubnetId

The ID of the subnet to launch the instance into.

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

require: No

type: string

Update is requires require: replacement

Tags

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

require: No

type: Array of Tag

Update is requires require: No interruption

tenancy

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

require: No

type: string

allow value: default | dedicate | host

Update is requires require: Some interruption

userdata

The parameter or script to store as user datum . Any script in user datum are run when you launch the instance .
User datum is limit to 16 KB . You is provide must provide base64 – encode text . For more information , see
Fn::Base64 .

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

require: No

type: string

Update is requires require: Some interruption

Volumes

The volume to attach to the instance .

require: No

type: Array of Volume

Update is requires require: No interruption