Package software.amazon.awscdk.services.ec2

Class LaunchTemplateProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.LaunchTemplateProps.Jsii$Proxy

All Implemented Interfaces:

LaunchTemplateProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

LaunchTemplateProps

@Stability(Stable)
@Internal
public static final class LaunchTemplateProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements LaunchTemplateProps

An implementation for LaunchTemplateProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.LaunchTemplateProps

LaunchTemplateProps.Builder, LaunchTemplateProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(LaunchTemplateProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the LaunchTemplateProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Boolean	getAssociatePublicIpAddress()	Whether instances should have a public IP addresses associated with them.
final List<BlockDevice>	getBlockDevices()	Specifies how block devices are exposed to the instance.
final CpuCredits	getCpuCredits()	CPU credit type for burstable EC2 instance types.
final Boolean	getDetailedMonitoring()	If set to true, then detailed monitoring will be enabled on instances created with this launch template.
final Boolean	getDisableApiTermination()	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;
final Boolean	getEbsOptimized()	Indicates whether the instances are optimized for Amazon EBS I/O.
final Boolean	getHibernationConfigured()	If you set this parameter to true, the instance is enabled for hibernation.
final Boolean	getHttpEndpoint()	Enables or disables the HTTP metadata endpoint on your instances.
final Boolean	getHttpProtocolIpv6()	Enables or disables the IPv6 endpoint for the instance metadata service.
final Number	getHttpPutResponseHopLimit()	The desired HTTP PUT response hop limit for instance metadata requests.
final LaunchTemplateHttpTokens	getHttpTokens()	The state of token usage for your instance metadata requests.
final InstanceInitiatedShutdownBehavior	getInstanceInitiatedShutdownBehavior()	Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
final Boolean	getInstanceMetadataTags()	Set to enabled to allow access to instance tags from the instance metadata.
final IInstanceProfile	getInstanceProfile()	The instance profile used to pass role information to EC2 instances.
final InstanceType	getInstanceType()	Type of instance to launch.
final String	getKeyName()	(deprecated) Name of SSH keypair to grant access to instance.
final IKeyPair	getKeyPair()	The SSH keypair to grant access to the instance.
final String	getLaunchTemplateName()	Name for this launch template.
final IMachineImage	getMachineImage()	The AMI that will be used by instances.
final Boolean	getNitroEnclaveEnabled()	If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves;
final IPlacementGroupRef	getPlacementGroup()	The placement group that you want to launch the instance into.
final Boolean	getRequireImdsv2()	Whether IMDSv2 should be required on launched instances.
final IRole	getRole()	An IAM role to associate with the instance profile that is used by instances.
final ISecurityGroup	getSecurityGroup()	Security group to assign to instances created with the launch template.
final LaunchTemplateSpotOptions	getSpotOptions()	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.
final UserData	getUserData()	The user data to make available to the instance.
final String	getVersionDescription()	A description for the first version of the launch template.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(LaunchTemplateProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the LaunchTemplateProps.Builder.

Method Details

getAssociatePublicIpAddress

public final Boolean getAssociatePublicIpAddress()

Description copied from interface: LaunchTemplateProps

Whether instances should have a public IP addresses associated with them.

Default: - Use subnet settings

Specified by:

getAssociatePublicIpAddress in interface LaunchTemplateProps

getBlockDevices

public final List<BlockDevice> getBlockDevices()

Description copied from interface: LaunchTemplateProps

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

Specified by:

getBlockDevices in interface LaunchTemplateProps

See Also:

• https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html

getCpuCredits

public final CpuCredits getCpuCredits()

Description copied from interface: LaunchTemplateProps

CPU credit type for burstable EC2 instance types.

Default: - No credit type is specified in the Launch Template.

Specified by:

getCpuCredits in interface LaunchTemplateProps

See Also:

• https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html

getDetailedMonitoring

public final Boolean getDetailedMonitoring()

Description copied from interface: LaunchTemplateProps

If set to true, then detailed monitoring will be enabled on instances created with this launch template.

Default: False - Detailed monitoring is disabled.

Specified by:

getDetailedMonitoring in interface LaunchTemplateProps

See Also:

• https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html

getDisableApiTermination

public final Boolean getDisableApiTermination()

Description copied from interface: LaunchTemplateProps

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.

Specified by:

getDisableApiTermination in interface LaunchTemplateProps

getEbsOptimized

public final Boolean getEbsOptimized()

Description copied from interface: LaunchTemplateProps

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.

Specified by:

getEbsOptimized in interface LaunchTemplateProps

getHibernationConfigured

public final Boolean getHibernationConfigured()

Description copied from interface: LaunchTemplateProps

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.

Specified by:

getHibernationConfigured in interface LaunchTemplateProps

getHttpEndpoint

public final Boolean getHttpEndpoint()

Description copied from interface: LaunchTemplateProps

Enables or disables the HTTP metadata endpoint on your instances.

Default: true

Specified by:

getHttpEndpoint in interface LaunchTemplateProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpendpoint

getHttpProtocolIpv6

public final Boolean getHttpProtocolIpv6()

Description copied from interface: LaunchTemplateProps

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: true

Specified by:

getHttpProtocolIpv6 in interface LaunchTemplateProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpprotocolipv6

getHttpPutResponseHopLimit

public final Number getHttpPutResponseHopLimit()

Description copied from interface: LaunchTemplateProps

The desired HTTP PUT response hop limit for instance metadata requests.

The larger the number, the further instance metadata requests can travel.

Default: 1

Specified by:

getHttpPutResponseHopLimit in interface LaunchTemplateProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpputresponsehoplimit

getHttpTokens

public final LaunchTemplateHttpTokens getHttpTokens()

Description copied from interface: LaunchTemplateProps

The state of token usage for your instance metadata requests.

The default state is optional if not specified. However, if requireImdsv2 is true, the state must be required.

Default: LaunchTemplateHttpTokens.OPTIONAL

Specified by:

getHttpTokens in interface LaunchTemplateProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httptokens

getInstanceInitiatedShutdownBehavior

public final InstanceInitiatedShutdownBehavior getInstanceInitiatedShutdownBehavior()

Description copied from interface: LaunchTemplateProps

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.

Specified by:

getInstanceInitiatedShutdownBehavior in interface LaunchTemplateProps

See Also:

• https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingInstanceInitiatedShutdownBehavior

getInstanceMetadataTags

public final Boolean getInstanceMetadataTags()

Description copied from interface: LaunchTemplateProps

Set to enabled to allow access to instance tags from the instance metadata.

Set to disabled to turn off access to instance tags from the instance metadata.

Default: false

Specified by:

getInstanceMetadataTags in interface LaunchTemplateProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-instancemetadatatags

getInstanceProfile

public final IInstanceProfile getInstanceProfile()

Description copied from interface: LaunchTemplateProps

The instance profile used to pass role information to EC2 instances.

Note: You can provide an instanceProfile or a role, but not both.

Default: - No instance profile

Specified by:

getInstanceProfile in interface LaunchTemplateProps

getInstanceType

public final InstanceType getInstanceType()

Description copied from interface: LaunchTemplateProps

Type of instance to launch.

Default: - This Launch Template does not specify a default Instance Type.

Specified by:

getInstanceType in interface LaunchTemplateProps

getKeyName

public final String getKeyName()

Description copied from interface: LaunchTemplateProps

(deprecated) Name of SSH keypair to grant access to instance.

Default: - No SSH access will be possible.

Specified by:

getKeyName in interface LaunchTemplateProps

getKeyPair

public final IKeyPair getKeyPair()

Description copied from interface: LaunchTemplateProps

The SSH keypair to grant access to the instance.

Default: - No SSH access will be possible.

Specified by:

getKeyPair in interface LaunchTemplateProps

getLaunchTemplateName

public final String getLaunchTemplateName()

Description copied from interface: LaunchTemplateProps

Name for this launch template.

Default: Automatically generated name

Specified by:

getLaunchTemplateName in interface LaunchTemplateProps

getMachineImage

public final IMachineImage getMachineImage()

Description copied from interface: LaunchTemplateProps

The AMI that will be used by instances.

Default: - This Launch Template does not specify a default AMI.

Specified by:

getMachineImage in interface LaunchTemplateProps

getNitroEnclaveEnabled

public final Boolean getNitroEnclaveEnabled()

Description copied from interface: LaunchTemplateProps

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.

Specified by:

getNitroEnclaveEnabled in interface LaunchTemplateProps

getPlacementGroup

public final IPlacementGroupRef getPlacementGroup()

Description copied from interface: LaunchTemplateProps

The placement group that you want to launch the instance into.

Default: - no placement group will be used for this launch template.

Specified by:

getPlacementGroup in interface LaunchTemplateProps

getRequireImdsv2

public final Boolean getRequireImdsv2()

Description copied from interface: LaunchTemplateProps

Whether IMDSv2 should be required on launched instances.

Default: - false

Specified by:

getRequireImdsv2 in interface LaunchTemplateProps

getRole

public final IRole getRole()

Description copied from interface: LaunchTemplateProps

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. Note: You can provide an instanceProfile or a role, but not both.

Default: - No new role is created.

Example:

 Role role = Role.Builder.create(this, "MyRole")
         .assumedBy(new ServicePrincipal("ec2.amazonaws.com"))
         .build();
 

Specified by:

getRole in interface LaunchTemplateProps

getSecurityGroup

public final ISecurityGroup getSecurityGroup()

Description copied from interface: LaunchTemplateProps

Security group to assign to instances created with the launch template.

Default: No security group is assigned.

Specified by:

getSecurityGroup in interface LaunchTemplateProps

getSpotOptions

public final LaunchTemplateSpotOptions getSpotOptions()

Description copied from interface: LaunchTemplateProps

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.

Specified by:

getSpotOptions in interface LaunchTemplateProps

getUserData

public final UserData getUserData()

Description copied from interface: LaunchTemplateProps

The user data to make available to the instance.

Default: - This Launch Template creates a UserData based on the type of provided machineImage; no UserData is created if a machineImage is not provided

Specified by:

getUserData in interface LaunchTemplateProps

getVersionDescription

public final String getVersionDescription()

Description copied from interface: LaunchTemplateProps

A description for the first version of the launch template.

The version description must be maximum 255 characters long.

Default: - No description

Specified by:

getVersionDescription in interface LaunchTemplateProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-versiondescription

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object