AWSEC2RequestLaunchTemplateData Class Reference


                    
                    
                    blockDeviceMappings

The block device mapping.

Declaration

Objective-C

@property (nonatomic, strong) NSArray<AWSEC2LaunchTemplateBlockDeviceMappingRequest *> *_Nullable blockDeviceMappings;

Swift

var blockDeviceMappings: [AWSEC2LaunchTemplateBlockDeviceMappingRequest]? { get set }


                    
                    
                    capacityReservationSpecification

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

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2LaunchTemplateCapacityReservationSpecificationRequest *_Nullable capacityReservationSpecification;

Swift

var capacityReservationSpecification: AWSEC2LaunchTemplateCapacityReservationSpecificationRequest? { get set }


                    
                    
                    cpuOptions

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2LaunchTemplateCpuOptionsRequest *_Nullable cpuOptions;

Swift

var cpuOptions: AWSEC2LaunchTemplateCpuOptionsRequest? { get set }


                    
                    
                    creditSpecification

The credit option for CPU usage of the instance. Valid only for T instances.

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2CreditSpecificationRequest *_Nullable creditSpecification;

Swift

var creditSpecification: AWSEC2CreditSpecificationRequest? { get set }


                    
                    
                    disableApiStop

Indicates whether to enable the instance for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.

Declaration

Objective-C

@property (nonatomic, strong) NSNumber *_Nullable disableApiStop;

Swift

var disableApiStop: NSNumber? { get set }


                    
                    
                    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 can terminate the instance by running the shutdown command from the instance.

Declaration

Objective-C

@property (nonatomic, strong) NSNumber *_Nullable disableApiTermination;

Swift

var disableApiTermination: NSNumber? { get set }


                    
                    
                    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.

Declaration

Objective-C

@property (nonatomic, strong) NSNumber *_Nullable ebsOptimized;

Swift

var ebsOptimized: NSNumber? { get set }


                    
                    
                    elasticGpuSpecifications

Deprecated.

Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.

Declaration

Objective-C

@property (nonatomic, strong) NSArray<AWSEC2ElasticGpuSpecification *> *_Nullable elasticGpuSpecifications;

Swift

var elasticGpuSpecifications: [AWSEC2ElasticGpuSpecification]? { get set }


                    
                    
                    elasticInferenceAccelerators

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

Declaration

Objective-C

@property (nonatomic, strong) NSArray<AWSEC2LaunchTemplateElasticInferenceAccelerator *> *_Nullable elasticInferenceAccelerators;

Swift

var elasticInferenceAccelerators: [AWSEC2LaunchTemplateElasticInferenceAccelerator]? { get set }


                    
                    
                    enclaveOptions

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.

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2LaunchTemplateEnclaveOptionsRequest *_Nullable enclaveOptions;

Swift

var enclaveOptions: AWSEC2LaunchTemplateEnclaveOptionsRequest? { get set }


                    
                    
                    hibernationOptions

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.

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2LaunchTemplateHibernationOptionsRequest *_Nullable hibernationOptions;

Swift

var hibernationOptions: AWSEC2LaunchTemplateHibernationOptionsRequest? { get set }


                    
                    
                    iamInstanceProfile

The name or Amazon Resource Name (ARN) of an IAM instance profile.

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2LaunchTemplateIamInstanceProfileSpecificationRequest *_Nullable iamInstanceProfile;

Swift

var iamInstanceProfile: AWSEC2LaunchTemplateIamInstanceProfileSpecificationRequest? { get set }


                    
                    
                    imageId

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-17characters00000
resolve:ssm:parameter-name
resolve:ssm:parameter-name:version-number
resolve:ssm:parameter-name:label
resolve:ssm:public-parameter

Currently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID.

For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable imageId;

Swift

var imageId: String? { get set }


                    
                    
                    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

Declaration

Objective-C

@property (nonatomic) AWSEC2ShutdownBehavior instanceInitiatedShutdownBehavior;

Swift

var instanceInitiatedShutdownBehavior: AWSEC2ShutdownBehavior { get set }


                    
                    
                    instanceMarketOptions

The market (purchasing) option for the instances.

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2LaunchTemplateInstanceMarketOptionsRequest *_Nullable instanceMarketOptions;

Swift

var instanceMarketOptions: AWSEC2LaunchTemplateInstanceMarketOptionsRequest? { get set }


                    
                    
                    instanceRequirements

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.

When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.

To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:

AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.

If you specify InstanceRequirements, you can’t specify InstanceType.

Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can’t specify InstanceRequirements.

For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2InstanceRequirementsRequest *_Nullable instanceRequirements;

Swift

var instanceRequirements: AWSEC2InstanceRequirementsRequest? { get set }


                    
                    
                    instanceType

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

If you specify InstanceType, you can’t specify InstanceRequirements.

Declaration

Objective-C

@property (nonatomic) AWSEC2InstanceType instanceType;

Swift

var instanceType: AWSEC2InstanceType { get set }


                    
                    
                    kernelId

The ID of the kernel.

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.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable kernelId;

Swift

var kernelId: String? { get set }


                    
                    
                    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.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable keyName;

Swift

var keyName: String? { get set }


                    
                    
                    licenseSpecifications

The license configurations.

Declaration

Objective-C

@property (nonatomic, strong) NSArray<AWSEC2LaunchTemplateLicenseConfigurationRequest *> *_Nullable licenseSpecifications;

Swift

var licenseSpecifications: [AWSEC2LaunchTemplateLicenseConfigurationRequest]? { get set }


                    
                    
                    maintenanceOptions

The maintenance options for the instance.

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2LaunchTemplateInstanceMaintenanceOptionsRequest *_Nullable maintenanceOptions;

Swift

var maintenanceOptions: AWSEC2LaunchTemplateInstanceMaintenanceOptionsRequest? { get set }


                    
                    
                    metadataOptions

The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2LaunchTemplateInstanceMetadataOptionsRequest *_Nullable metadataOptions;

Swift

var metadataOptions: AWSEC2LaunchTemplateInstanceMetadataOptionsRequest? { get set }


                    
                    
                    monitoring

The monitoring for the instance.

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2LaunchTemplatesMonitoringRequest *_Nullable monitoring;

Swift

var monitoring: AWSEC2LaunchTemplatesMonitoringRequest? { get set }


                    
                    
                    networkInterfaces

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.

Declaration

Objective-C

@property (nonatomic, strong) NSArray<AWSEC2LaunchTemplateInstanceNetworkInterfaceSpecificationRequest *> *_Nullable networkInterfaces;

Swift

var networkInterfaces: [AWSEC2LaunchTemplateInstanceNetworkInterfaceSpecificationRequest]? { get set }


                    
                    
                    placement

The placement for the instance.

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2LaunchTemplatePlacementRequest *_Nullable placement;

Swift

var placement: AWSEC2LaunchTemplatePlacementRequest? { get set }


                    
                    
                    privateDnsNameOptions

The options for the instance hostname. The default values are inherited from the subnet.

Declaration

Objective-C

@property (nonatomic, strong) AWSEC2LaunchTemplatePrivateDnsNameOptionsRequest *_Nullable privateDnsNameOptions;

Swift

var privateDnsNameOptions: AWSEC2LaunchTemplatePrivateDnsNameOptionsRequest? { get set }


                    
                    
                    ramDiskId

The ID of the RAM disk.

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.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable ramDiskId;

Swift

var ramDiskId: String? { get set }


                    
                    
                    securityGroupIds

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Declaration

Objective-C

@property (nonatomic, strong) NSArray<NSString *> *_Nullable securityGroupIds;

Swift

var securityGroupIds: [String]? { get set }


                    
                    
                    securityGroups

One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Declaration

Objective-C

@property (nonatomic, strong) NSArray<NSString *> *_Nullable securityGroups;

Swift

var securityGroups: [String]? { get set }


                    
                    
                    tagSpecifications

The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template.

Declaration

Objective-C

@property (nonatomic, strong) NSArray<AWSEC2LaunchTemplateTagSpecificationRequest *> *_Nullable tagSpecifications;

Swift

var tagSpecifications: [AWSEC2LaunchTemplateTagSpecificationRequest]? { get set }


                    
                    
                    userData

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.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable userData;

Swift

var userData: String? { get set }