LaunchTemplateProps (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.6 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: LaunchTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:17.100Z")
 @Stability(value=Experimental)
public interface LaunchTemplateProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties of a LaunchTemplate.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`LaunchTemplateProps.Builder` A builder for `LaunchTemplateProps`
`static class`	`LaunchTemplateProps.Jsii$Proxy` An implementation for `LaunchTemplateProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static LaunchTemplateProps.Builder`	`builder()`
`default List<BlockDevice>`	`getBlockDevices()` (experimental) Specifies how block devices are exposed to the instance.
`default CpuCredits`	`getCpuCredits()` (experimental) CPU credit type for burstable EC2 instance types.
`default Boolean`	`getDetailedMonitoring()` (experimental) If set to true, then detailed monitoring will be enabled on instances created with this launch template.
`default Boolean`	`getDisableApiTermination()` (experimental) If you set this parameter to true, you cannot terminate the instances launched with this launch template using the Amazon EC2 console, CLI, or API;
`default Boolean`	`getEbsOptimized()` (experimental) Indicates whether the instances are optimized for Amazon EBS I/O.
`default Boolean`	`getHibernationConfigured()` (experimental) If you set this parameter to true, the instance is enabled for hibernation.
`default InstanceInitiatedShutdownBehavior`	`getInstanceInitiatedShutdownBehavior()` (experimental) Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
`default InstanceType`	`getInstanceType()` (experimental) Type of instance to launch.
`default String`	`getKeyName()` (experimental) Name of SSH keypair to grant access to instance.
`default String`	`getLaunchTemplateName()` (experimental) Name for this launch template.
`default IMachineImage`	`getMachineImage()` (experimental) The AMI that will be used by instances.
`default Boolean`	`getNitroEnclaveEnabled()` (experimental) If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves;
`default IRole`	`getRole()` (experimental) An IAM role to associate with the instance profile that is used by instances.
`default ISecurityGroup`	`getSecurityGroup()` (experimental) Security group to assign to instances created with the launch template.
`default LaunchTemplateSpotOptions`	`getSpotOptions()` (experimental) If this property is defined, then the Launch Template's InstanceMarketOptions will be set to use Spot instances, and the options for the Spot instances will be as defined.
`default UserData`	`getUserData()` (experimental) The AMI that will be used by instances.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getBlockDevices
```
@Stability(value=Experimental)
 @Nullable
default List<BlockDevice> getBlockDevices()
```
    (experimental) Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
    Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.
    Default: - Uses the block device mapping of the AMI
    
    See Also:
    
    https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
  - getCpuCredits
```
@Stability(value=Experimental)
 @Nullable
default CpuCredits getCpuCredits()
```
    (experimental) CPU credit type for burstable EC2 instance types.
    Default: - No credit type is specified in the Launch Template.
    
    See Also:
    
    https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html
  - getDetailedMonitoring
```
@Stability(value=Experimental)
 @Nullable
default Boolean getDetailedMonitoring()
```
    (experimental) If set to true, then detailed monitoring will be enabled on instances created with this launch template.
    Default: False - Detailed monitoring is disabled.
    
    See Also:
    
    https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html
  - getDisableApiTermination
```
@Stability(value=Experimental)
 @Nullable
default Boolean getDisableApiTermination()
```
    (experimental) If you set this parameter to true, you cannot terminate the instances launched with this launch template using the Amazon EC2 console, CLI, or API;
    otherwise, you can.
    Default: - The API termination setting is not specified in the Launch Template.
  - getEbsOptimized
```
@Stability(value=Experimental)
 @Nullable
default Boolean getEbsOptimized()
```
    (experimental) Indicates whether the instances are 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.
    Default: - EBS optimization is not specified in the launch template.
  - getHibernationConfigured
```
@Stability(value=Experimental)
 @Nullable
default Boolean getHibernationConfigured()
```
    (experimental) If you set this parameter to true, the instance is enabled for hibernation.
    Default: - Hibernation configuration is not specified in the launch template; defaulting to false.
  - getInstanceInitiatedShutdownBehavior
```
@Stability(value=Experimental)
 @Nullable
default InstanceInitiatedShutdownBehavior getInstanceInitiatedShutdownBehavior()
```
    (experimental) Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
    Default: - Shutdown behavior is not specified in the launch template; defaults to STOP.
    
    See Also:
    
    https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingInstanceInitiatedShutdownBehavior
  - getInstanceType
```
@Stability(value=Experimental)
 @Nullable
default InstanceType getInstanceType()
```
    (experimental) Type of instance to launch.
    Default: - This Launch Template does not specify a default Instance Type.
  - getKeyName
```
@Stability(value=Experimental)
 @Nullable
default String getKeyName()
```
    (experimental) Name of SSH keypair to grant access to instance.
    Default: - No SSH access will be possible.
  - getLaunchTemplateName
```
@Stability(value=Experimental)
 @Nullable
default String getLaunchTemplateName()
```
    (experimental) Name for this launch template.
    Default: Automatically generated name
  - getMachineImage
```
@Stability(value=Experimental)
 @Nullable
default IMachineImage getMachineImage()
```
    (experimental) The AMI that will be used by instances.
    Default: - This Launch Template does not specify a default AMI.
  - getNitroEnclaveEnabled
```
@Stability(value=Experimental)
 @Nullable
default Boolean getNitroEnclaveEnabled()
```
    (experimental) If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves;
    otherwise, it is not enabled for AWS Nitro Enclaves.
    Default: - Enablement of Nitro enclaves is not specified in the launch template; defaulting to false.
  - getRole
```
@Stability(value=Experimental)
 @Nullable
default IRole getRole()
```
    (experimental) An IAM role to associate with the instance profile that is used by instances.
    The role must be assumable by the service principal ec2.amazonaws.com:
    Default: - No new role is created.
    Example:
    // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 Role role = new Role(this, "MyRole", new RoleProps() .assumedBy(new ServicePrincipal("ec2.amazonaws.com")));
  - getSecurityGroup
```
@Stability(value=Experimental)
 @Nullable
default ISecurityGroup getSecurityGroup()
```
    (experimental) Security group to assign to instances created with the launch template.
    Default: No security group is assigned.
  - getSpotOptions
```
@Stability(value=Experimental)
 @Nullable
default LaunchTemplateSpotOptions getSpotOptions()
```
    (experimental) If this property is defined, then the Launch Template's InstanceMarketOptions will be set to use Spot instances, and the options for the Spot instances will be as defined.
    Default: - Instance launched with this template will not be spot instances.
  - getUserData
```
@Stability(value=Experimental)
 @Nullable
default UserData getUserData()
```
    (experimental) The AMI that will be used by instances.
    Default: - This Launch Template creates a UserData based on the type of provided machineImage; no UserData is created if a machineImage is not provided
  - builder
```
@Stability(value=Experimental)
static LaunchTemplateProps.Builder builder()
```
    Returns:
    
    a LaunchTemplateProps.Builder of LaunchTemplateProps

Interface LaunchTemplateProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getBlockDevices

getCpuCredits

getDetailedMonitoring

getDisableApiTermination

getEbsOptimized

getHibernationConfigured

getInstanceInitiatedShutdownBehavior

getInstanceType

getKeyName

getLaunchTemplateName

getMachineImage

getNitroEnclaveEnabled

getRole

getSecurityGroup

getSpotOptions

getUserData

builder