software.amazon.awscdk.services.ec2

Interface CfnLaunchTemplate.LaunchTemplateDataProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunchTemplate.LaunchTemplateDataProperty.Jsii$Proxy

Enclosing class:

CfnLaunchTemplate

@Stability(value=Stable)
public static interface CfnLaunchTemplate.LaunchTemplateDataProperty
extends software.amazon.jsii.JsiiSerializable

The information to include in the launch template.

You must specify at least one parameter for the launch template data.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 LaunchTemplateDataProperty launchTemplateDataProperty = LaunchTemplateDataProperty.builder()
         .blockDeviceMappings(List.of(BlockDeviceMappingProperty.builder()
                 .deviceName("deviceName")
                 .ebs(EbsProperty.builder()
                         .deleteOnTermination(false)
                         .encrypted(false)
                         .iops(123)
                         .kmsKeyId("kmsKeyId")
                         .snapshotId("snapshotId")
                         .throughput(123)
                         .volumeSize(123)
                         .volumeType("volumeType")
                         .build())
                 .noDevice("noDevice")
                 .virtualName("virtualName")
                 .build()))
         .capacityReservationSpecification(CapacityReservationSpecificationProperty.builder()
                 .capacityReservationPreference("capacityReservationPreference")
                 .capacityReservationTarget(CapacityReservationTargetProperty.builder()
                         .capacityReservationId("capacityReservationId")
                         .capacityReservationResourceGroupArn("capacityReservationResourceGroupArn")
                         .build())
                 .build())
         .cpuOptions(CpuOptionsProperty.builder()
                 .coreCount(123)
                 .threadsPerCore(123)
                 .build())
         .creditSpecification(CreditSpecificationProperty.builder()
                 .cpuCredits("cpuCredits")
                 .build())
         .disableApiStop(false)
         .disableApiTermination(false)
         .ebsOptimized(false)
         .elasticGpuSpecifications(List.of(ElasticGpuSpecificationProperty.builder()
                 .type("type")
                 .build()))
         .elasticInferenceAccelerators(List.of(LaunchTemplateElasticInferenceAcceleratorProperty.builder()
                 .count(123)
                 .type("type")
                 .build()))
         .enclaveOptions(EnclaveOptionsProperty.builder()
                 .enabled(false)
                 .build())
         .hibernationOptions(HibernationOptionsProperty.builder()
                 .configured(false)
                 .build())
         .iamInstanceProfile(IamInstanceProfileProperty.builder()
                 .arn("arn")
                 .name("name")
                 .build())
         .imageId("imageId")
         .instanceInitiatedShutdownBehavior("instanceInitiatedShutdownBehavior")
         .instanceMarketOptions(InstanceMarketOptionsProperty.builder()
                 .marketType("marketType")
                 .spotOptions(SpotOptionsProperty.builder()
                         .blockDurationMinutes(123)
                         .instanceInterruptionBehavior("instanceInterruptionBehavior")
                         .maxPrice("maxPrice")
                         .spotInstanceType("spotInstanceType")
                         .validUntil("validUntil")
                         .build())
                 .build())
         .instanceRequirements(InstanceRequirementsProperty.builder()
                 .acceleratorCount(AcceleratorCountProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .acceleratorManufacturers(List.of("acceleratorManufacturers"))
                 .acceleratorNames(List.of("acceleratorNames"))
                 .acceleratorTotalMemoryMiB(AcceleratorTotalMemoryMiBProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .acceleratorTypes(List.of("acceleratorTypes"))
                 .bareMetal("bareMetal")
                 .baselineEbsBandwidthMbps(BaselineEbsBandwidthMbpsProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .burstablePerformance("burstablePerformance")
                 .cpuManufacturers(List.of("cpuManufacturers"))
                 .excludedInstanceTypes(List.of("excludedInstanceTypes"))
                 .instanceGenerations(List.of("instanceGenerations"))
                 .localStorage("localStorage")
                 .localStorageTypes(List.of("localStorageTypes"))
                 .memoryGiBPerVCpu(MemoryGiBPerVCpuProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .memoryMiB(MemoryMiBProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .networkInterfaceCount(NetworkInterfaceCountProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .onDemandMaxPricePercentageOverLowestPrice(123)
                 .requireHibernateSupport(false)
                 .spotMaxPricePercentageOverLowestPrice(123)
                 .totalLocalStorageGb(TotalLocalStorageGBProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .vCpuCount(VCpuCountProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .build())
         .instanceType("instanceType")
         .kernelId("kernelId")
         .keyName("keyName")
         .licenseSpecifications(List.of(LicenseSpecificationProperty.builder()
                 .licenseConfigurationArn("licenseConfigurationArn")
                 .build()))
         .maintenanceOptions(MaintenanceOptionsProperty.builder()
                 .autoRecovery("autoRecovery")
                 .build())
         .metadataOptions(MetadataOptionsProperty.builder()
                 .httpEndpoint("httpEndpoint")
                 .httpProtocolIpv6("httpProtocolIpv6")
                 .httpPutResponseHopLimit(123)
                 .httpTokens("httpTokens")
                 .instanceMetadataTags("instanceMetadataTags")
                 .build())
         .monitoring(MonitoringProperty.builder()
                 .enabled(false)
                 .build())
         .networkInterfaces(List.of(NetworkInterfaceProperty.builder()
                 .associateCarrierIpAddress(false)
                 .associatePublicIpAddress(false)
                 .deleteOnTermination(false)
                 .description("description")
                 .deviceIndex(123)
                 .groups(List.of("groups"))
                 .interfaceType("interfaceType")
                 .ipv4PrefixCount(123)
                 .ipv4Prefixes(List.of(Ipv4PrefixSpecificationProperty.builder()
                         .ipv4Prefix("ipv4Prefix")
                         .build()))
                 .ipv6AddressCount(123)
                 .ipv6Addresses(List.of(Ipv6AddProperty.builder()
                         .ipv6Address("ipv6Address")
                         .build()))
                 .ipv6PrefixCount(123)
                 .ipv6Prefixes(List.of(Ipv6PrefixSpecificationProperty.builder()
                         .ipv6Prefix("ipv6Prefix")
                         .build()))
                 .networkCardIndex(123)
                 .networkInterfaceId("networkInterfaceId")
                 .privateIpAddress("privateIpAddress")
                 .privateIpAddresses(List.of(PrivateIpAddProperty.builder()
                         .primary(false)
                         .privateIpAddress("privateIpAddress")
                         .build()))
                 .secondaryPrivateIpAddressCount(123)
                 .subnetId("subnetId")
                 .build()))
         .placement(PlacementProperty.builder()
                 .affinity("affinity")
                 .availabilityZone("availabilityZone")
                 .groupName("groupName")
                 .hostId("hostId")
                 .hostResourceGroupArn("hostResourceGroupArn")
                 .partitionNumber(123)
                 .spreadDomain("spreadDomain")
                 .tenancy("tenancy")
                 .build())
         .privateDnsNameOptions(PrivateDnsNameOptionsProperty.builder()
                 .enableResourceNameDnsAaaaRecord(false)
                 .enableResourceNameDnsARecord(false)
                 .hostnameType("hostnameType")
                 .build())
         .ramDiskId("ramDiskId")
         .securityGroupIds(List.of("securityGroupIds"))
         .securityGroups(List.of("securityGroups"))
         .tagSpecifications(List.of(TagSpecificationProperty.builder()
                 .resourceType("resourceType")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .userData("userData")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLaunchTemplate.LaunchTemplateDataProperty.Builder A builder for CfnLaunchTemplate.LaunchTemplateDataProperty
static class	CfnLaunchTemplate.LaunchTemplateDataProperty.Jsii$Proxy An implementation for CfnLaunchTemplate.LaunchTemplateDataProperty

Method Summary

Modifier and Type	Method and Description
static CfnLaunchTemplate.LaunchTemplateDataProperty.Builder	builder()
default Object	getBlockDeviceMappings() The block device mapping.
default Object	getCapacityReservationSpecification() The Capacity Reservation targeting option.
default Object	getCpuOptions() The CPU options for the instance.
default Object	getCreditSpecification() The credit option for CPU usage of the instance.
default Object	getDisableApiStop() `CfnLaunchTemplate.LaunchTemplateDataProperty.DisableApiStop`.
default Object	getDisableApiTermination() If you set this parameter to `true` , you can't terminate the instance using the Amazon EC2 console, CLI, or API;
default Object	getEbsOptimized() Indicates whether the instance is optimized for Amazon EBS I/O.
default Object	getElasticGpuSpecifications() An elastic GPU to associate with the instance.
default Object	getElasticInferenceAccelerators() The elastic inference accelerator for the instance.
default Object	getEnclaveOptions() Indicates whether the instance is enabled for AWS Nitro Enclaves.
default Object	getHibernationOptions() Indicates whether an instance is enabled for hibernation.
default Object	getIamInstanceProfile() The name or Amazon Resource Name (ARN) of an IAM instance profile.
default String	getImageId() The ID of the AMI.
default String	getInstanceInitiatedShutdownBehavior() Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
default Object	getInstanceMarketOptions() The market (purchasing) option for the instances.
default Object	getInstanceRequirements() The attributes for the instance types.
default String	getInstanceType() The instance type.
default String	getKernelId() The ID of the kernel.
default String	getKeyName() The name of the key pair.
default Object	getLicenseSpecifications() The license configurations.
default Object	getMaintenanceOptions() `CfnLaunchTemplate.LaunchTemplateDataProperty.MaintenanceOptions`.
default Object	getMetadataOptions() The metadata options for the instance.
default Object	getMonitoring() The monitoring for the instance.
default Object	getNetworkInterfaces() One or more network interfaces.
default Object	getPlacement() The placement for the instance.
default Object	getPrivateDnsNameOptions() The options for the instance hostname.
default String	getRamDiskId() The ID of the RAM disk.
default List<String>	getSecurityGroupIds() One or more security group IDs.
default List<String>	getSecurityGroups() [EC2-Classic, default VPC] One or more security group names.
default Object	getTagSpecifications() The tags to apply to the resources during launch.
default String	getUserData() The user data to make available to the instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBlockDeviceMappings

@Stability(value=Stable)
 @Nullable
default Object getBlockDeviceMappings()

The block device mapping.

getCapacityReservationSpecification

@Stability(value=Stable)
 @Nullable
default Object getCapacityReservationSpecification()

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

getCpuOptions

@Stability(value=Stable)
 @Nullable
default Object getCpuOptions()

The CPU options for the instance.

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

getCreditSpecification

@Stability(value=Stable)
 @Nullable
default Object getCreditSpecification()

The credit option for CPU usage of the instance.

Valid for T2, T3, or T3a instances only.

getDisableApiStop

@Stability(value=Stable)
 @Nullable
default Object getDisableApiStop()

`CfnLaunchTemplate.LaunchTemplateDataProperty.DisableApiStop`.

getDisableApiTermination

@Stability(value=Stable)
 @Nullable
default Object getDisableApiTermination()

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.

getEbsOptimized

@Stability(value=Stable)
 @Nullable
default Object getEbsOptimized()

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.

getElasticGpuSpecifications

@Stability(value=Stable)
 @Nullable
default Object getElasticGpuSpecifications()

An elastic GPU to associate with the instance.

getElasticInferenceAccelerators

@Stability(value=Stable)
 @Nullable
default Object getElasticInferenceAccelerators()

The elastic inference accelerator for the instance.

getEnclaveOptions

@Stability(value=Stable)
 @Nullable
default Object getEnclaveOptions()

Indicates whether the instance is enabled for AWS Nitro Enclaves.

For more information, see What is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide .

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

getHibernationOptions

@Stability(value=Stable)
 @Nullable
default Object getHibernationOptions()

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 .

getIamInstanceProfile

@Stability(value=Stable)
 @Nullable
default Object getIamInstanceProfile()

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

getImageId

@Stability(value=Stable)
 @Nullable
default String getImageId()

The ID of the AMI.

getInstanceInitiatedShutdownBehavior

@Stability(value=Stable)
 @Nullable
default String getInstanceInitiatedShutdownBehavior()

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

getInstanceMarketOptions

@Stability(value=Stable)
 @Nullable
default Object getInstanceMarketOptions()

The market (purchasing) option for the instances.

getInstanceRequirements

@Stability(value=Stable)
 @Nullable
default Object getInstanceRequirements()

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 specify InstanceTypes .

getInstanceType

@Stability(value=Stable)
 @Nullable
default String getInstanceType()

The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide* .

If you specify InstanceTypes , you can't specify InstanceRequirements .

getKernelId

@Stability(value=Stable)
 @Nullable
default String getKernelId()

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 EC2 User Guide .

getKeyName

@Stability(value=Stable)
 @Nullable
default String getKeyName()

The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html) .

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.

getLicenseSpecifications

@Stability(value=Stable)
 @Nullable
default Object getLicenseSpecifications()

The license configurations.

getMaintenanceOptions

@Stability(value=Stable)
 @Nullable
default Object getMaintenanceOptions()

`CfnLaunchTemplate.LaunchTemplateDataProperty.MaintenanceOptions`.

getMetadataOptions

@Stability(value=Stable)
 @Nullable
default Object getMetadataOptions()

The metadata options for the instance.

For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide .

getMonitoring

@Stability(value=Stable)
 @Nullable
default Object getMonitoring()

The monitoring for the instance.

getNetworkInterfaces

@Stability(value=Stable)
 @Nullable
default Object getNetworkInterfaces()

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.

getPlacement

@Stability(value=Stable)
 @Nullable
default Object getPlacement()

The placement for the instance.

getPrivateDnsNameOptions

@Stability(value=Stable)
 @Nullable
default Object getPrivateDnsNameOptions()

The options for the instance hostname.

The default values are inherited from the subnet.

getRamDiskId

@Stability(value=Stable)
 @Nullable
default String getRamDiskId()

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 .

getSecurityGroupIds

@Stability(value=Stable)
 @Nullable
default List<String> getSecurityGroupIds()

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.

getSecurityGroups

@Stability(value=Stable)
 @Nullable
default List<String> getSecurityGroups()

[EC2-Classic, default VPC] 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.

getTagSpecifications

@Stability(value=Stable)
 @Nullable
default Object getTagSpecifications()

The tags to apply to the resources during launch.

You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch.

getUserData

@Stability(value=Stable)
 @Nullable
default String getUserData()

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 AWS 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 AWS Batch User Guide .

builder

@Stability(value=Stable)
static CfnLaunchTemplate.LaunchTemplateDataProperty.Builder builder()

Returns:

a CfnLaunchTemplate.LaunchTemplateDataProperty.Builder of CfnLaunchTemplate.LaunchTemplateDataProperty