EC2 / Client / create_launch_template
create_launch_template#
- EC2.Client.create_launch_template(**kwargs)#
Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
See also: AWS API Documentation
Request Syntax
response = client.create_launch_template( DryRun=True|False, ClientToken='string', LaunchTemplateName='string', VersionDescription='string', LaunchTemplateData={ 'KernelId': 'string', 'EbsOptimized': True|False, 'IamInstanceProfile': { 'Arn': 'string', 'Name': 'string' }, 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'VirtualName': 'string', 'Ebs': { 'Encrypted': True|False, 'DeleteOnTermination': True|False, 'Iops': 123, 'KmsKeyId': 'string', 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'Throughput': 123 }, 'NoDevice': 'string' }, ], 'NetworkInterfaces': [ { 'AssociateCarrierIpAddress': True|False, 'AssociatePublicIpAddress': True|False, 'DeleteOnTermination': True|False, 'Description': 'string', 'DeviceIndex': 123, 'Groups': [ 'string', ], 'InterfaceType': 'string', 'Ipv6AddressCount': 123, 'Ipv6Addresses': [ { 'Ipv6Address': 'string' }, ], 'NetworkInterfaceId': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], 'SecondaryPrivateIpAddressCount': 123, 'SubnetId': 'string', 'NetworkCardIndex': 123, 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv4PrefixCount': 123, 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'Ipv6PrefixCount': 123 }, ], 'ImageId': 'string', 'InstanceType': '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', 'KeyName': 'string', 'Monitoring': { 'Enabled': True|False }, 'Placement': { 'AvailabilityZone': 'string', 'Affinity': 'string', 'GroupName': 'string', 'HostId': 'string', 'Tenancy': 'default'|'dedicated'|'host', 'SpreadDomain': 'string', 'HostResourceGroupArn': 'string', 'PartitionNumber': 123, 'GroupId': 'string' }, 'RamDiskId': 'string', 'DisableApiTermination': True|False, 'InstanceInitiatedShutdownBehavior': 'stop'|'terminate', 'UserData': 'string', 'TagSpecifications': [ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'ElasticGpuSpecifications': [ { 'Type': 'string' }, ], 'ElasticInferenceAccelerators': [ { 'Type': 'string', 'Count': 123 }, ], 'SecurityGroupIds': [ 'string', ], 'SecurityGroups': [ 'string', ], 'InstanceMarketOptions': { 'MarketType': 'spot', 'SpotOptions': { 'MaxPrice': 'string', 'SpotInstanceType': 'one-time'|'persistent', 'BlockDurationMinutes': 123, 'ValidUntil': datetime(2015, 1, 1), 'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate' } }, 'CreditSpecification': { 'CpuCredits': 'string' }, 'CpuOptions': { 'CoreCount': 123, 'ThreadsPerCore': 123 }, 'CapacityReservationSpecification': { 'CapacityReservationPreference': 'open'|'none', 'CapacityReservationTarget': { 'CapacityReservationId': 'string', 'CapacityReservationResourceGroupArn': 'string' } }, 'LicenseSpecifications': [ { 'LicenseConfigurationArn': 'string' }, ], 'HibernationOptions': { 'Configured': True|False }, 'MetadataOptions': { 'HttpTokens': 'optional'|'required', 'HttpPutResponseHopLimit': 123, 'HttpEndpoint': 'disabled'|'enabled', 'HttpProtocolIpv6': 'disabled'|'enabled', 'InstanceMetadataTags': 'disabled'|'enabled' }, 'EnclaveOptions': { 'Enabled': True|False }, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'nvidia'|'amd'|'amazon-web-services'|'xilinx', ], 'AcceleratorNames': [ 'a100'|'v100'|'k80'|'t4'|'m60'|'radeon-pro-v520'|'vu9p'|'inferentia'|'k520', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ] }, 'PrivateDnsNameOptions': { 'HostnameType': 'ip-name'|'resource-name', 'EnableResourceNameDnsARecord': True|False, 'EnableResourceNameDnsAAAARecord': True|False }, 'MaintenanceOptions': { 'AutoRecovery': 'default'|'disabled' }, 'DisableApiStop': True|False }, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] )
- Parameters:
DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation. Otherwise, it isUnauthorizedOperation.ClientToken (string) –
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraint: Maximum 128 ASCII characters.
LaunchTemplateName (string) –
[REQUIRED]
A name for the launch template.
VersionDescription (string) – A description for the first version of the launch template.
LaunchTemplateData (dict) –
[REQUIRED]
The information for the launch template.
KernelId (string) –
The ID of the kernel.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Elastic Compute Cloud User Guide.
EbsOptimized (boolean) –
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.
IamInstanceProfile (dict) –
The name or Amazon Resource Name (ARN) of an IAM instance profile.
Arn (string) –
The Amazon Resource Name (ARN) of the instance profile.
Name (string) –
The name of the instance profile.
BlockDeviceMappings (list) –
The block device mapping.
(dict) –
Describes a block device mapping.
DeviceName (string) –
The device name (for example, /dev/sdh or xvdh).
VirtualName (string) –
The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. 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.
Ebs (dict) –
Parameters used to automatically set up EBS volumes when the instance is launched.
Encrypted (boolean) –
Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can’t specify an encryption value.
DeleteOnTermination (boolean) –
Indicates whether the EBS volume is deleted on instance termination.
Iops (integer) –
The number of I/O operations per second (IOPS). For
gp3,io1, andio2volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2volumes, 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 IOPSio1: 100-64,000 IOPSio2: 100-64,000 IOPS
For
io1andio2volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.This parameter is supported for
io1,io2, andgp3volumes only. This parameter is not supported forgp2,st1,sc1, orstandardvolumes.KmsKeyId (string) –
The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.
SnapshotId (string) –
The ID of the snapshot.
VolumeSize (integer) –
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
gp2andgp3: 1-16,384io1andio2: 4-16,384st1andsc1: 125-16,384standard: 1-1,024
VolumeType (string) –
The volume type. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Throughput (integer) –
The throughput to provision for a
gp3volume, with a maximum of 1,000 MiB/s.Valid Range: Minimum value of 125. Maximum value of 1000.
NoDevice (string) –
To omit the device from the block device mapping, specify an empty string.
NetworkInterfaces (list) –
One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
(dict) –
The parameters for a network interface.
AssociateCarrierIpAddress (boolean) –
Associates a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide.
AssociatePublicIpAddress (boolean) –
Associates a public IPv4 address with eth0 for a new network interface.
DeleteOnTermination (boolean) –
Indicates whether the network interface is deleted when the instance is terminated.
Description (string) –
A description for the network interface.
DeviceIndex (integer) –
The device index for the network interface attachment.
Groups (list) –
The IDs of one or more security groups.
(string) –
InterfaceType (string) –
The type of network interface. To create an Elastic Fabric Adapter (EFA), specify
efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.If you are not creating an EFA, specify
interfaceor omit this parameter.Valid values:
interface|efaIpv6AddressCount (integer) –
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can’t use this option if specifying specific IPv6 addresses.
Ipv6Addresses (list) –
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can’t use this option if you’re specifying a number of IPv6 addresses.
(dict) –
Describes an IPv6 address.
Ipv6Address (string) –
The IPv6 address.
NetworkInterfaceId (string) –
The ID of the network interface.
PrivateIpAddress (string) –
The primary private IPv4 address of the network interface.
PrivateIpAddresses (list) –
One or more private IPv4 addresses.
(dict) –
Describes a secondary private IPv4 address for a network interface.
Primary (boolean) –
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
PrivateIpAddress (string) –
The private IPv4 address.
SecondaryPrivateIpAddressCount (integer) –
The number of secondary private IPv4 addresses to assign to a network interface.
SubnetId (string) –
The ID of the subnet for the network interface.
NetworkCardIndex (integer) –
The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
Ipv4Prefixes (list) –
One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the
Ipv4PrefixCountoption.(dict) –
Describes the IPv4 prefix option for a network interface.
Ipv4Prefix (string) –
The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
Ipv4PrefixCount (integer) –
The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the
Ipv4Prefixoption.Ipv6Prefixes (list) –
One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the
Ipv6PrefixCountoption.(dict) –
Describes the IPv4 prefix option for a network interface.
Ipv6Prefix (string) –
The IPv6 prefix.
Ipv6PrefixCount (integer) –
The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the
Ipv6Prefixoption.
ImageId (string) –
The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.
Valid formats:
ami-17characters00000resolve:ssm:parameter-nameresolve:ssm:parameter-name:version-numberresolve:ssm:parameter-name:label
For more information, see Use a Systems Manager parameter to find an AMI in the Amazon Elastic Compute Cloud User Guide.
InstanceType (string) –
The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.
If you specify
InstanceType, you can’t specifyInstanceRequirements.KeyName (string) –
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
Warning
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.
Monitoring (dict) –
The monitoring for the instance.
Enabled (boolean) –
Specify
trueto enable detailed monitoring. Otherwise, basic monitoring is enabled.
Placement (dict) –
The placement for the instance.
AvailabilityZone (string) –
The Availability Zone for the instance.
Affinity (string) –
The affinity setting for an instance on a Dedicated Host.
GroupName (string) –
The name of the placement group for the instance.
HostId (string) –
The ID of the Dedicated Host for the instance.
Tenancy (string) –
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
SpreadDomain (string) –
Reserved for future use.
HostResourceGroupArn (string) –
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.PartitionNumber (integer) –
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to
partition.GroupId (string) –
The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.
RamDiskId (string) –
The ID of the RAM disk.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Elastic Compute Cloud User Guide.
DisableApiTermination (boolean) –
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 setInstanceInitiatedShutdownBehaviortoterminate, you can terminate the instance by running the shutdown command from the instance.InstanceInitiatedShutdownBehavior (string) –
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default:
stopUserData (string) –
The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Run commands on your Linux instance at launch (Linux) or Work with instance user data (Windows) in the Amazon Elastic Compute Cloud User Guide.
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
TagSpecifications (list) –
The tags to apply to the resources that are created during instance launch.
You can specify tags for the following resources only:
Instances
Volumes
Elastic graphics
Spot Instance requests
Network interfaces
To tag a resource after it has been created, see CreateTags.
Note
To tag the launch template itself, you must use the TagSpecification parameter.
(dict) –
The tags specification for the resources that are created during instance launch.
ResourceType (string) –
The type of resource to tag.
The
Valid Valuesare all the resource types that can be tagged. However, when creating a launch template, you can specify tags for the following resource types only:instance|volume|elastic-gpu|network-interface|spot-instances-requestTo tag a resource after it has been created, see CreateTags.
Tags (list) –
The tags to apply to the resource.
(dict) –
Describes a tag.
Key (string) –
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with
aws:.Value (string) –
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
ElasticGpuSpecifications (list) –
An elastic GPU to associate with the instance.
(dict) –
A specification for an Elastic Graphics accelerator.
Type (string) – [REQUIRED]
The type of Elastic Graphics accelerator. For more information about the values to specify for
Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances.
ElasticInferenceAccelerators (list) –
The elastic inference accelerator for the instance.
(dict) –
Describes an elastic inference accelerator.
Type (string) – [REQUIRED]
The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
Count (integer) –
The number of elastic inference accelerators to attach to the instance.
Default: 1
SecurityGroupIds (list) –
One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.
(string) –
SecurityGroups (list) –
One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
(string) –
InstanceMarketOptions (dict) –
The market (purchasing) option for the instances.
MarketType (string) –
The market type.
SpotOptions (dict) –
The options for Spot Instances.
MaxPrice (string) –
The maximum hourly price you’re willing to pay for the Spot Instances. 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 Spot Instances will be interrupted more frequently than if you do not specify this parameter.
SpotInstanceType (string) –
The Spot Instance request type.
BlockDurationMinutes (integer) –
Deprecated.
ValidUntil (datetime) –
The end date of the request, in UTC format (*YYYY-MM-DD*T*HH:MM:SS*Z). Supported only for persistent requests.
For a persistent request, the request remains active until the
ValidUntildate and time is reached. Otherwise, the request remains active until you cancel it.For a one-time request,
ValidUntilis not supported. The request remains active until all instances launch or you cancel the request.
Default: 7 days from the current date
InstanceInterruptionBehavior (string) –
The behavior when a Spot Instance is interrupted. The default is
terminate.
CreditSpecification (dict) –
The credit option for CPU usage of the instance. Valid only for T instances.
CpuCredits (string) – [REQUIRED]
The credit option for CPU usage of a T instance.
Valid values:
standard|unlimited
CpuOptions (dict) –
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.
CoreCount (integer) –
The number of CPU cores for the instance.
ThreadsPerCore (integer) –
The number of threads per CPU core. To disable multithreading for the instance, specify a value of
1. Otherwise, specify the default value of2.
CapacityReservationSpecification (dict) –
The Capacity Reservation targeting option. If you do not specify this parameter, the instance’s Capacity Reservation preference defaults to
open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).CapacityReservationPreference (string) –
Indicates the instance’s Capacity Reservation preferences. Possible preferences include:
open- The instance can run in anyopenCapacity Reservation that has matching attributes (instance type, platform, Availability Zone).none- The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
CapacityReservationTarget (dict) –
Information about the target Capacity Reservation or Capacity Reservation group.
CapacityReservationId (string) –
The ID of the Capacity Reservation in which to run the instance.
CapacityReservationResourceGroupArn (string) –
The ARN of the Capacity Reservation resource group in which to run the instance.
LicenseSpecifications (list) –
The license configurations.
(dict) –
Describes a license configuration.
LicenseConfigurationArn (string) –
The Amazon Resource Name (ARN) of the license configuration.
HibernationOptions (dict) –
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.
Configured (boolean) –
If you set this parameter to
true, the instance is enabled for hibernation.Default:
false
MetadataOptions (dict) –
The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.
HttpTokens (string) –
IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to
optional(in other words, set the use of IMDSv2 tooptional) orrequired(in other words, set the use of IMDSv2 torequired).optional- When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.required- When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default:
optionalHttpPutResponseHopLimit (integer) –
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default:
1Possible values: Integers from 1 to 64
HttpEndpoint (string) –
Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is
enabled.Note
If you specify a value of
disabled, you will not be able to access your instance metadata.HttpProtocolIpv6 (string) –
Enables or disables the IPv6 endpoint for the instance metadata service.
Default:
disabledInstanceMetadataTags (string) –
Set to
enabledto allow access to instance tags from the instance metadata. Set todisabledto turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.Default:
disabled
EnclaveOptions (dict) –
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
You can’t enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
Enabled (boolean) –
To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to
true.
InstanceRequirements (dict) –
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
If you specify
InstanceRequirements, you can’t specifyInstanceType.VCpuCount (dict) – [REQUIRED]
The minimum and maximum number of vCPUs.
Min (integer) – [REQUIRED]
The minimum number of vCPUs. To specify no minimum limit, specify
0.Max (integer) –
The maximum number of vCPUs. To specify no maximum limit, omit this parameter.
MemoryMiB (dict) – [REQUIRED]
The minimum and maximum amount of memory, in MiB.
Min (integer) – [REQUIRED]
The minimum amount of memory, in MiB. To specify no minimum limit, specify
0.Max (integer) –
The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.
CpuManufacturers (list) –
The CPU manufacturers to include.
For instance types with Intel CPUs, specify
intel.For instance types with AMD CPUs, specify
amd.For instance types with Amazon Web Services CPUs, specify
amazon-web-services.
Note
Don’t confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
(string) –
MemoryGiBPerVCpu (dict) –
The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
Min (float) –
The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.
Max (float) –
The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.
ExcludedInstanceTypes (list) –
The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk (
*), to exclude an instance family, type, size, or generation. The following are examples:m5.8xlarge,c5*.*,m5a.*,r*,*3*.For example, if you specify
c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.Note
If you specify
ExcludedInstanceTypes, you can’t specifyAllowedInstanceTypes.Default: No excluded instance types
(string) –
InstanceGenerations (list) –
Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.
For current generation instance types, specify
current.For previous generation instance types, specify
previous.Default: Current and previous generation instance types
(string) –
SpotMaxPricePercentageOverLowestPrice (integer) –
The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as
999999.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
Note
If you set
TargetCapacityUnitTypetovcpuormemory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.Default:
100OnDemandMaxPricePercentageOverLowestPrice (integer) –
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as
999999.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
Note
If you set
TargetCapacityUnitTypetovcpuormemory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.Default:
20BareMetal (string) –
Indicates whether bare metal instance types must be included, excluded, or required.
To include bare metal instance types, specify
included.To require only bare metal instance types, specify
required.To exclude bare metal instance types, specify
excluded.
Default:
excludedBurstablePerformance (string) –
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
To include burstable performance instance types, specify
included.To require only burstable performance instance types, specify
required.To exclude burstable performance instance types, specify
excluded.
Default:
excludedRequireHibernateSupport (boolean) –
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default:
falseNetworkInterfaceCount (dict) –
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
Min (integer) –
The minimum number of network interfaces. To specify no minimum limit, omit this parameter.
Max (integer) –
The maximum number of network interfaces. To specify no maximum limit, omit this parameter.
LocalStorage (string) –
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
To include instance types with instance store volumes, specify
included.To require only instance types with instance store volumes, specify
required.To exclude instance types with instance store volumes, specify
excluded.
Default:
includedLocalStorageTypes (list) –
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify
hdd.For instance types with solid state drive (SSD) storage, specify
ssd.
Default:
hddandssd(string) –
TotalLocalStorageGB (dict) –
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
Min (float) –
The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.
Max (float) –
The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.
BaselineEbsBandwidthMbps (dict) –
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
Min (integer) –
The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.
Max (integer) –
The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.
AcceleratorTypes (list) –
The accelerator types that must be on the instance type.
To include instance types with GPU hardware, specify
gpu.To include instance types with FPGA hardware, specify
fpga.To include instance types with inference hardware, specify
inference.
Default: Any accelerator type
(string) –
AcceleratorCount (dict) –
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set
Maxto0.Default: No minimum or maximum limits
Min (integer) –
The minimum number of accelerators. To specify no minimum limit, omit this parameter.
Max (integer) –
The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set
Maxto0.
AcceleratorManufacturers (list) –
Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify
nvidia.For instance types with AMD devices, specify
amd.For instance types with Amazon Web Services devices, specify
amazon-web-services.For instance types with Xilinx devices, specify
xilinx.
Default: Any manufacturer
(string) –
AcceleratorNames (list) –
The accelerators that must be on the instance type.
For instance types with NVIDIA A100 GPUs, specify
a100.For instance types with NVIDIA V100 GPUs, specify
v100.For instance types with NVIDIA K80 GPUs, specify
k80.For instance types with NVIDIA T4 GPUs, specify
t4.For instance types with NVIDIA M60 GPUs, specify
m60.For instance types with AMD Radeon Pro V520 GPUs, specify
radeon-pro-v520.For instance types with Xilinx VU9P FPGAs, specify
vu9p.For instance types with Amazon Web Services Inferentia chips, specify
inferentia.For instance types with NVIDIA GRID K520 GPUs, specify
k520.
Default: Any accelerator
(string) –
AcceleratorTotalMemoryMiB (dict) –
The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
Min (integer) –
The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.
Max (integer) –
The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.
NetworkBandwidthGbps (dict) –
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
Min (float) –
The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter.
Max (float) –
The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.
AllowedInstanceTypes (list) –
The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (
*), to allow an instance type, size, or generation. The following are examples:m5.8xlarge,c5*.*,m5a.*,r*,*3*.For example, if you specify
c5*,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.Note
If you specify
AllowedInstanceTypes, you can’t specifyExcludedInstanceTypes.Default: All instance types
(string) –
PrivateDnsNameOptions (dict) –
The options for the instance hostname. The default values are inherited from the subnet.
HostnameType (string) –
The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 native 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.
EnableResourceNameDnsARecord (boolean) –
Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
EnableResourceNameDnsAAAARecord (boolean) –
Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
MaintenanceOptions (dict) –
The maintenance options for the instance.
AutoRecovery (string) –
Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.
DisableApiStop (boolean) –
Indicates whether to enable the instance for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.
TagSpecifications (list) –
The tags to apply to the launch template on creation. To tag the launch template, the resource type must be
launch-template.Note
To specify the tags for the resources that are created when an instance is launched, you must use the
TagSpecificationsparameter in the launch template data structure.(dict) –
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
Note
The
Valid Valueslists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.ResourceType (string) –
The type of resource to tag on creation.
Tags (list) –
The tags to apply to the resource.
(dict) –
Describes a tag.
Key (string) –
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with
aws:.Value (string) –
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- Return type:
dict
- Returns:
Response Syntax
{ 'LaunchTemplate': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'CreateTime': datetime(2015, 1, 1), 'CreatedBy': 'string', 'DefaultVersionNumber': 123, 'LatestVersionNumber': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Warning': { 'Errors': [ { 'Code': 'string', 'Message': 'string' }, ] } }
Response Structure
(dict) –
LaunchTemplate (dict) –
Information about the launch template.
LaunchTemplateId (string) –
The ID of the launch template.
LaunchTemplateName (string) –
The name of the launch template.
CreateTime (datetime) –
The time launch template was created.
CreatedBy (string) –
The principal that created the launch template.
DefaultVersionNumber (integer) –
The version number of the default version of the launch template.
LatestVersionNumber (integer) –
The version number of the latest version of the launch template.
Tags (list) –
The tags for the launch template.
(dict) –
Describes a tag.
Key (string) –
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with
aws:.Value (string) –
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
Warning (dict) –
If the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that’s found.
Errors (list) –
The error codes and error messages.
(dict) –
The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.
Code (string) –
The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error codes.
Message (string) –
The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error codes.
Examples
This example creates a launch template that specifies the subnet in which to launch the instance, assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance.
response = client.create_launch_template( LaunchTemplateData={ 'ImageId': 'ami-8c1be5f6', 'InstanceType': 't2.small', 'NetworkInterfaces': [ { 'AssociatePublicIpAddress': True, 'DeviceIndex': 0, 'Ipv6AddressCount': 1, 'SubnetId': 'subnet-7b16de0c', }, ], 'TagSpecifications': [ { 'ResourceType': 'instance', 'Tags': [ { 'Key': 'Name', 'Value': 'webserver', }, ], }, ], }, LaunchTemplateName='my-template', VersionDescription='WebVersion1', ) print(response)
Expected Output:
{ 'LaunchTemplate': { 'CreateTime': datetime(2017, 11, 27, 9, 13, 24, 0, 331, 0), 'CreatedBy': 'arn:aws:iam::123456789012:root', 'DefaultVersionNumber': 1, 'LatestVersionNumber': 1, 'LaunchTemplateId': 'lt-01238c059e3466abc', 'LaunchTemplateName': 'my-template', }, 'ResponseMetadata': { '...': '...', }, }