LaunchConfiguration (AWS Java SDK :: Services

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

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

@Generated(value="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 and Description

static interface LaunchConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LaunchConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`associatePublicIpAddress()` For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP address to the group's instances.
`List<BlockDeviceMapping>`	`blockDeviceMappings()` A block device mapping, which specifies the block devices for the instance.
`static LaunchConfiguration.Builder`	`builder()`
`String`	`classicLinkVPCId()` The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
`List<String>`	`classicLinkVPCSecurityGroups()` The IDs of one or more security groups for the VPC specified in `ClassicLinkVPCId`.
`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()` Returns true if the BlockDeviceMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasClassicLinkVPCSecurityGroups()` Returns true if the ClassicLinkVPCSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasSecurityGroups()` Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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.
`String`	`placementTenancy()` The tenancy of the instance, either `default` or `dedicated`.
`String`	`ramdiskId()` The ID of the RAM disk associated with the AMI.
`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 Base64-encoded 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 String launchConfigurationName()
```
    The name of the launch configuration.
    
    Returns:
    
    The name of the launch configuration.
  - launchConfigurationARN
```
public String launchConfigurationARN()
```
    The Amazon Resource Name (ARN) of the launch configuration.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the launch configuration.
  - imageId
```
public String imageId()
```
    The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.
    
    For more information, see Finding an 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 Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
  - keyName
```
public String keyName()
```
    The name of the key pair.
    
    For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
    
    Returns:
    
    The name of the key pair.
    
    For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
  - hasSecurityGroups
```
public boolean hasSecurityGroups()
```
    Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - securityGroups
```
public List<String> securityGroups()
```
    A list that contains the security groups to assign to the instances in the Auto Scaling group.
    
    For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSecurityGroups() to see if a value was sent in this field.
    
    Returns:
    
    A list that contains the security groups to assign to the instances in the Auto Scaling group.
    
    For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
  - classicLinkVPCId
```
public String classicLinkVPCId()
```
    The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
    
    For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
    
    For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
  - hasClassicLinkVPCSecurityGroups
```
public boolean hasClassicLinkVPCSecurityGroups()
```
    Returns true if the ClassicLinkVPCSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - classicLinkVPCSecurityGroups
```
public List<String> classicLinkVPCSecurityGroups()
```
    The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId.
    
    For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasClassicLinkVPCSecurityGroups() to see if a value was sent in this field.
    
    Returns:
    
    The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId.
    
    For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
  - userData
```
public String userData()
```
    The Base64-encoded user data to make available to the launched EC2 instances.
    
    For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.
    
    Returns:
    
    The Base64-encoded user data to make available to the launched EC2 instances.
    
    For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.
  - instanceType
```
public 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 String kernelId()
```
    The ID of the kernel associated with the AMI.
    
    Returns:
    
    The ID of the kernel associated with the AMI.
  - ramdiskId
```
public 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 boolean hasBlockDeviceMappings()
```
    Returns true if the BlockDeviceMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - blockDeviceMappings
```
public List<BlockDeviceMapping> blockDeviceMappings()
```
    A block device mapping, which specifies the block devices for the instance.
    
    For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasBlockDeviceMappings() to see if a value was sent in this field.
    
    Returns:
    
    A block device mapping, which specifies the block devices for the instance.
    
    For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
  - instanceMonitoring
```
public 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 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 Launching Spot Instances in Your Auto Scaling Group 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 Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
  - iamInstanceProfile
```
public 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 Instant createdTime()
```
    The creation date and time for the launch configuration.
    
    Returns:
    
    The creation date and time for the launch configuration.
  - ebsOptimized
```
public 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 Boolean associatePublicIpAddress()
```
    For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP address to the group's instances.
    
    For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP address to the group's instances.
    
    For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
  - placementTenancy
```
public 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.
    
    For more information, see Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide.
    
    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.
    
    For more information, see Instance Placement Tenancy 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields 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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields