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()` For Auto Scaling groups that are running in a virtual private cloud (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 CreateLaunchConfigurationRequest.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 specified ClassicLink-enabled VPC.
`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) 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.
`String`	`placementTenancy()` The tenancy of the instance.
`String`	`ramdiskId()` The ID of the RAM disk to select.
`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 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 Base64-encoded 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 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 String imageId()
```
    The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
    
    If you do not specify InstanceId, you must specify ImageId.
    
    Returns:
    
    The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
    
    If you do not specify InstanceId, you must specify ImageId.
  - 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.
    
    [EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
    
    [EC2-Classic] Specify either the security group names or the security group IDs. For more information, see Amazon EC2 Security Groups 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 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.
    
    [EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
    
    [EC2-Classic] Specify either the security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances.
  - 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.
    
    This parameter can only be used if you are launching EC2-Classic instances.
    
    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.
    
    This parameter can only be used if you are launching EC2-Classic instances.
  - 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 specified ClassicLink-enabled VPC. 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.
    
    If you specify the ClassicLinkVPCId parameter, you must specify this parameter.
    
    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 specified ClassicLink-enabled VPC. 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.
    
    If you specify the ClassicLinkVPCId parameter, you must specify this parameter.
  - 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.
  - instanceId
```
public 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 Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.
    
    If you do not specify InstanceId, you must specify both ImageId and InstanceType.
    
    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 Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.
    
    If you do not specify InstanceId, you must specify both ImageId and InstanceType.
  - instanceType
```
public 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 do not specify InstanceId, you must specify InstanceType.
    
    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 do not specify InstanceId, you must specify InstanceType.
  - 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 to select.
    
    Returns:
    
    The ID of the RAM disk to select.
  - 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. You can specify virtual devices and EBS volumes. 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. You can specify virtual devices and EBS volumes. 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.
    
    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 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.
    
    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 Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
    
    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 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 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 Boolean associatePublicIpAddress()
```
    For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. If you specify true, each instance in the Auto Scaling group receives a unique public IP address. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
    
    If you specify this parameter, you must specify at least one subnet for VPCZoneIdentifier when you create your group.
    
    If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet.
    
    Returns:
    
    For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. If you specify true, each instance in the Auto Scaling group receives a unique public IP address. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
    
    If you specify this parameter, you must specify at least one subnet for VPCZoneIdentifier when you create your group.
    
    If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet.
  - placementTenancy
```
public String placementTenancy()
```
    The tenancy of the instance. 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 parameter to dedicated.
    
    If you specify PlacementTenancy, you must specify at least one subnet for VPCZoneIdentifier when you create your group.
    
    For more information, see Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide.
    
    Valid Values: default | dedicated
    
    Returns:
    
    The tenancy of the instance. 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 parameter to dedicated.
    
    If you specify PlacementTenancy, you must specify at least one subnet for VPCZoneIdentifier when you create your group.
    
    For more information, see Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide.
    
    Valid Values: default | dedicated
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public 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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields