FleetLaunchTemplateOverridesRequest¶
Structure Class¶
FleetLaunchTemplateOverridesRequest
dataclass
¶
Bases: _SerdeShape
Describes overrides for a launch template.
Attributes¶
availability_zone
class-attribute
instance-attribute
¶
availability_zone: str | None = ...
The Availability Zone in which to launch the instances. For example,
us-east-2a.
Either AvailabilityZone or AvailabilityZoneId must be specified in
the request, but not both.
availability_zone_id
class-attribute
instance-attribute
¶
availability_zone_id: str | None = ...
The ID of the Availability Zone in which to launch the instances. For
example, use2-az1.
Either AvailabilityZone or AvailabilityZoneId must be specified in
the request, but not both.
block_device_mappings
class-attribute
instance-attribute
¶
block_device_mappings: list[FleetBlockDeviceMappingRequest] | None = ...
The block device mappings, which define the EBS volumes and instance store volumes to attach to the instance at launch.
Supported only for fleets of type instant.
For more information, see Block device mappings for volumes on Amazon EC2 instances in the Amazon EC2 User Guide.
iam_instance_profile
class-attribute
instance-attribute
¶
iam_instance_profile: FleetIamInstanceProfileSpecificationRequest | None = ...
The IAM instance profile to associate with the instances.
Supported only for fleets of type instant.
For more information, see IAM roles for Amazon EC2 in the Amazon EC2 User Guide.
image_id
class-attribute
instance-attribute
¶
image_id: str | None = ...
The ID of the AMI in the format ami-17characters00000.
Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch.
To reference a public parameter:
resolve:ssm:public-parameter
To reference a parameter stored in the same account:
-
resolve:ssm:parameter-name -
resolve:ssm:parameter-name:version-number -
resolve:ssm:parameter-name:label
To reference a parameter shared from another Amazon Web Services account:
-
resolve:ssm:parameter-ARN -
resolve:ssm:parameter-ARN:version-number -
resolve:ssm:parameter-ARN:label
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.
Note
This parameter is only available for fleets of type instant. For
fleets of type maintain and request, you must specify the AMI ID in
the launch template.
instance_requirements
class-attribute
instance-attribute
¶
instance_requirements: InstanceRequirementsRequest | None = ...
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
Note
If you specify InstanceRequirements, you can't specify
InstanceType.
instance_type
class-attribute
instance-attribute
¶
instance_type: str | None = ...
The instance type.
mac1.metal is not supported as a launch template override.
Note
If you specify InstanceType, you can't specify
InstanceRequirements.
key_name
class-attribute
instance-attribute
¶
key_name: str | None = ...
The name of the key pair to use for the instances.
Supported only for fleets of type instant.
For more information, see Amazon EC2 key pairs in the Amazon EC2 User Guide.
max_price
class-attribute
instance-attribute
¶
max_price: str | None = ...
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
Warning
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
If you specify a maximum price, it must be more than USD $0.001.
Specifying a value below USD $0.001 will result in an
InvalidParameterValue error message.
metadata_options
class-attribute
instance-attribute
¶
metadata_options: FleetInstanceMetadataOptionsRequest | None = ...
The metadata options for the instances.
Supported only for fleets of type instant.
For more information, see Configure the instance metadata service in the Amazon EC2 User Guide.
placement
class-attribute
instance-attribute
¶
placement: Placement | None = ...
The location where the instance launched, if applicable.
priority
class-attribute
instance-attribute
¶
priority: float | None = ...
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet
uses priority to determine which launch template override to use first
in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to
capacity-optimized-prioritized, EC2 Fleet uses priority on a
best-effort basis to determine which launch template override to use in
fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number,
the higher the priority. If no number is set, the launch template
override has the lowest priority. You can set the same priority for
different launch template overrides.
subnet_id
class-attribute
instance-attribute
¶
subnet_id: str | None = ...
The IDs of the subnets in which to launch the instances. Separate
multiple subnet IDs using commas (for example,
subnet-1234abcdeexample1, subnet-0987cdef6example2). A request of type
instant can have only one subnet ID.
weighted_capacity
class-attribute
instance-attribute
¶
weighted_capacity: float | None = ...
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
Note
When specifying weights, the price used in the lowest-price and
price-capacity-optimized allocation strategies is per unit hour
(where the instance price is divided by the specified weight). However,
if all the specified weights are above the requested TargetCapacity,
resulting in only 1 instance being launched, the price used is per
instance hour.