java.lang.Object
- software.amazon.awssdk.services.autoscaling.model.LaunchConfiguration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<LaunchConfiguration.Builder,LaunchConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class LaunchConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LaunchConfiguration.Builder,LaunchConfiguration>

Describes a launch configuration.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface LaunchConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`associatePublicIpAddress()`	Specifies whether to assign a public IPv4 address to the group's instances.
`List<BlockDeviceMapping>`	`blockDeviceMappings()`	The block device mapping entries that define the block devices to attach to the instances at launch.
`static LaunchConfiguration.Builder`	`builder()`
`String`	`classicLinkVPCId()`	Available for backward compatibility.
`List<String>`	`classicLinkVPCSecurityGroups()`	Available for backward compatibility.
`Instant`	`createdTime()`	The creation date and time for the launch configuration.
`Boolean`	`ebsOptimized()`	Specifies whether the launch configuration is optimized for EBS I/O (`true`) or not ( `false`).
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBlockDeviceMappings()`	For responses, this returns true if the service returned a value for the BlockDeviceMappings property.
`boolean`	`hasClassicLinkVPCSecurityGroups()`	For responses, this returns true if the service returned a value for the ClassicLinkVPCSecurityGroups property.
`int`	`hashCode()`
`boolean`	`hasSecurityGroups()`	For responses, this returns true if the service returned a value for the SecurityGroups property.
`String`	`iamInstanceProfile()`	The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
`String`	`imageId()`	The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.
`InstanceMonitoring`	`instanceMonitoring()`	Controls whether instances in this group are launched with detailed (`true`) or basic ( `false`) monitoring.
`String`	`instanceType()`	The instance type for the instances.
`String`	`kernelId()`	The ID of the kernel associated with the AMI.
`String`	`keyName()`	The name of the key pair.
`String`	`launchConfigurationARN()`	The Amazon Resource Name (ARN) of the launch configuration.
`String`	`launchConfigurationName()`	The name of the launch configuration.
`InstanceMetadataOptions`	`metadataOptions()`	The metadata options for the instances.
`String`	`placementTenancy()`	The tenancy of the instance, either `default` or `dedicated`.
`String`	`ramdiskId()`	The ID of the RAM disk associated with the AMI.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()`	A list that contains the security groups to assign to the instances in the Auto Scaling group.
`static Class<? extends LaunchConfiguration.Builder>`	`serializableBuilderClass()`
`String`	`spotPrice()`	The maximum hourly price to be paid for any Spot Instance launched to fulfill the request.
`LaunchConfiguration.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userData()`	The user data to make available to the launched EC2 instances.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - launchConfigurationName
```
public final String launchConfigurationName()
```
    The name of the launch configuration.
    
    Returns:
    
    The name of the launch configuration.
  - launchConfigurationARN
```
public final String launchConfigurationARN()
```
    The Amazon Resource Name (ARN) of the launch configuration.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the launch configuration.
  - imageId
```
public final String imageId()
```
    The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Find a Linux AMI in the Amazon EC2 User Guide for Linux Instances.
    
    Returns:
    
    The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Find a Linux AMI in the Amazon EC2 User Guide for Linux Instances.
  - keyName
```
public final String keyName()
```
    The name of the key pair.
    
    For more information, see Amazon EC2 key pairs and Amazon EC2 instances in the Amazon EC2 User Guide for Linux Instances.
    
    Returns:
    
    The name of the key pair.
    
    For more information, see Amazon EC2 key pairs and Amazon EC2 instances in the Amazon EC2 User Guide for Linux Instances.
  - hasSecurityGroups
```
public final boolean hasSecurityGroups()
```
    For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - securityGroups
```
public final List<String> securityGroups()
```
    A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Control traffic to your Amazon Web Services resources using security groups in the Amazon Virtual Private Cloud User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroups() method.
    
    Returns:
    
    A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Control traffic to your Amazon Web Services resources using security groups in the Amazon Virtual Private Cloud User Guide.
  - classicLinkVPCId
```
public final String classicLinkVPCId()
```
    Available for backward compatibility.
    
    Returns:
    
    Available for backward compatibility.
  - hasClassicLinkVPCSecurityGroups
```
public final boolean hasClassicLinkVPCSecurityGroups()
```
    For responses, this returns true if the service returned a value for the ClassicLinkVPCSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - classicLinkVPCSecurityGroups
```
public final List<String> classicLinkVPCSecurityGroups()
```
    Available for backward compatibility.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClassicLinkVPCSecurityGroups() method.
    
    Returns:
    
    Available for backward compatibility.
  - userData
```
public final String userData()
```
    The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
    
    Returns:
    
    The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
  - instanceType
```
public final String instanceType()
```
    The instance type for the instances. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.
    
    Returns:
    
    The instance type for the instances. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.
  - kernelId
```
public final String kernelId()
```
    The ID of the kernel associated with the AMI.
    
    Returns:
    
    The ID of the kernel associated with the AMI.
  - ramdiskId
```
public final String ramdiskId()
```
    The ID of the RAM disk associated with the AMI.
    
    Returns:
    
    The ID of the RAM disk associated with the AMI.
  - hasBlockDeviceMappings
```
public final boolean hasBlockDeviceMappings()
```
    For responses, this returns true if the service returned a value for the BlockDeviceMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - blockDeviceMappings
```
public final List<BlockDeviceMapping> blockDeviceMappings()
```
    The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block device mappings in the Amazon EC2 User Guide for Linux Instances.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlockDeviceMappings() method.
    
    Returns:
    
    The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block device mappings in the Amazon EC2 User Guide for Linux Instances.
  - instanceMonitoring
```
public final InstanceMonitoring instanceMonitoring()
```
    Controls whether instances in this group are launched with detailed (true) or basic ( false) monitoring.
    
    For more information, see Configure monitoring for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    Controls whether instances in this group are launched with detailed (true) or basic ( false) monitoring.
    
    For more information, see Configure monitoring for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
  - spotPrice
```
public final String spotPrice()
```
    The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Requesting Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Requesting Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.
  - iamInstanceProfile
```
public final String iamInstanceProfile()
```
    The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
  - createdTime
```
public final Instant createdTime()
```
    The creation date and time for the launch configuration.
    
    Returns:
    
    The creation date and time for the launch configuration.
  - ebsOptimized
```
public final Boolean ebsOptimized()
```
    Specifies whether the launch configuration is optimized for EBS I/O (true) or not ( false). For more information, see Amazon EBS-optimized instances in the Amazon EC2 User Guide for Linux Instances.
    
    Returns:
    
    Specifies whether the launch configuration is optimized for EBS I/O (true) or not ( false). For more information, see Amazon EBS-optimized instances in the Amazon EC2 User Guide for Linux Instances.
  - associatePublicIpAddress
```
public final Boolean associatePublicIpAddress()
```
    Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet. For more information, see Provide network connectivity for your Auto Scaling instances using Amazon VPC in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet. For more information, see Provide network connectivity for your Auto Scaling instances using Amazon VPC in the Amazon EC2 Auto Scaling User Guide.
  - placementTenancy
```
public final String placementTenancy()
```
    The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.
    
    Returns:
    
    The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.
  - metadataOptions
```
public final InstanceMetadataOptions metadataOptions()
```
    The metadata options for the instances. For more information, see Configure the instance metadata options in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    The metadata options for the instances. For more information, see Configure the instance metadata options in the Amazon EC2 Auto Scaling User Guide.
  - toBuilder
```
public LaunchConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<LaunchConfiguration.Builder,LaunchConfiguration>
  - builder
```
public static LaunchConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends LaunchConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class LaunchConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

launchConfigurationName

launchConfigurationARN

imageId

keyName

hasSecurityGroups

securityGroups

classicLinkVPCId

hasClassicLinkVPCSecurityGroups

classicLinkVPCSecurityGroups

userData

instanceType

kernelId

ramdiskId

hasBlockDeviceMappings

blockDeviceMappings

instanceMonitoring

spotPrice

iamInstanceProfile

createdTime

ebsOptimized

associatePublicIpAddress

placementTenancy

metadataOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField