CreateLaunchConfigurationRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest
    - - software.amazon.awssdk.services.autoscaling.model.CreateLaunchConfigurationRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateLaunchConfigurationRequest.Builder,CreateLaunchConfigurationRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateLaunchConfigurationRequest
extends AutoScalingRequest
implements ToCopyableBuilder<CreateLaunchConfigurationRequest.Builder,CreateLaunchConfigurationRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateLaunchConfigurationRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 CreateLaunchConfigurationRequest.Builder`	`builder()`
`String`	`classicLinkVPCId()` Available for backward compatibility.
`List<String>`	`classicLinkVPCSecurityGroups()` Available for backward compatibility.
`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) that was assigned during registration.
`String`	`instanceId()` The ID of the instance to use to create the launch configuration.
`InstanceMonitoring`	`instanceMonitoring()` Controls whether instances in this group are launched with detailed (`true`) or basic ( `false`) monitoring.
`String`	`instanceType()` Specifies the instance type of the EC2 instance.
`String`	`kernelId()` The ID of the kernel associated with the AMI.
`String`	`keyName()` The name of the key pair.
`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 to select.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()` A list that contains the security group IDs to assign to the instances in the Auto Scaling group.
`static Class<? extends CreateLaunchConfigurationRequest.Builder>`	`serializableBuilderClass()`
`String`	`spotPrice()` The maximum hourly price to be paid for any Spot Instance launched to fulfill the request.
`CreateLaunchConfigurationRequest.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 software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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. This name must be unique per Region per account.
    
    Returns:
    
    The name of the launch configuration. This name must be unique per Region per account.
  - imageId
```
public final String imageId()
```
    The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding a Linux AMI in the Amazon EC2 User Guide for Linux Instances.
    
    If you specify InstanceId, an ImageId is not required.
    
    Returns:
    
    The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding a Linux AMI in the Amazon EC2 User Guide for Linux Instances.
    
    If you specify InstanceId, an ImageId is not required.
  - keyName
```
public final String keyName()
```
    The name of the key pair. For more information, see Amazon EC2 key pairs and Linux 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 Linux 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 group IDs to assign to the instances in the Auto Scaling group. For more information, see Control traffic to 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 group IDs to assign to the instances in the Auto Scaling group. For more information, see Control traffic to 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.
  - instanceId
```
public final String instanceId()
```
    The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.
    
    To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
    
    For more information, see Creating a launch configuration using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.
    
    To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
    
    For more information, see Creating a launch configuration using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
  - instanceType
```
public final String instanceType()
```
    Specifies the instance type of the EC2 instance. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.
    
    If you specify InstanceId, an InstanceType is not required.
    
    Returns:
    
    Specifies the instance type of the EC2 instance. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.
    
    If you specify InstanceId, an InstanceType is not required.
  - kernelId
```
public final String kernelId()
```
    The ID of the kernel associated with the AMI.
    
    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 for Linux Instances.
    
    Returns:
    
    The ID of the kernel associated with the AMI.
    
    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 for Linux Instances.
  - ramdiskId
```
public final String ramdiskId()
```
    The ID of the RAM disk to select.
    
    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 for Linux Instances.
    
    Returns:
    
    The ID of the RAM disk to select.
    
    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 for Linux Instances.
  - 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.
    
    The default value is true (enabled).
    
    When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. 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.
    
    The default value is true (enabled).
    
    When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. 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 Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.
    
    Valid Range: Minimum value of 0.001
    
    When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.
    
    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 Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.
    
    Valid Range: Minimum value of 0.001
    
    When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.
  - 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.
  - ebsOptimized
```
public final Boolean ebsOptimized()
```
    Specifies whether the launch configuration is optimized for EBS I/O (true) or not ( false). The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS-optimized instances in the Amazon EC2 User Guide for Linux Instances.
    
    The default value is false.
    
    Returns:
    
    Specifies whether the launch configuration is optimized for EBS I/O (true) or not ( false). The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS-optimized instances in the Amazon EC2 User Guide for Linux Instances.
    
    The default value is false.
  - 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.
    
    If you specify true, each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
    
    If you specify this property, you must specify at least one subnet for VPCZoneIdentifier when you create your group.
    
    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.
    
    If you specify true, each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
    
    If you specify this property, you must specify at least one subnet for VPCZoneIdentifier when you create your group.
  - 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. To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this property to dedicated. For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
    
    If you specify PlacementTenancy, you must specify at least one subnet for VPCZoneIdentifier when you create your group.
    
    Valid values: default | dedicated
    
    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. To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this property to dedicated . For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
    
    If you specify PlacementTenancy, you must specify at least one subnet for VPCZoneIdentifier when you create your group.
    
    Valid values: default | dedicated
  - metadataOptions
```
public final InstanceMetadataOptions metadataOptions()
```
    The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.
  - toBuilder
```
public CreateLaunchConfigurationRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateLaunchConfigurationRequest.Builder,CreateLaunchConfigurationRequest>
    
    Specified by:
    
    toBuilder in class AutoScalingRequest
  - builder
```
public static CreateLaunchConfigurationRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateLaunchConfigurationRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateLaunchConfigurationRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

launchConfigurationName

imageId

keyName

hasSecurityGroups

securityGroups

classicLinkVPCId

hasClassicLinkVPCSecurityGroups

classicLinkVPCSecurityGroups

userData

instanceId

instanceType

kernelId

ramdiskId

hasBlockDeviceMappings

blockDeviceMappings

instanceMonitoring

spotPrice

iamInstanceProfile

ebsOptimized

associatePublicIpAddress

placementTenancy

metadataOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields