Package software.amazon.awssdk.services.autoscaling.model

Interface CreateLaunchConfigurationRequest.Builder

All Superinterfaces:
AutoScalingRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateLaunchConfigurationRequest.Builder,CreateLaunchConfigurationRequest>, SdkBuilder<CreateLaunchConfigurationRequest.Builder,CreateLaunchConfigurationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateLaunchConfigurationRequest
public static interface CreateLaunchConfigurationRequest.Builder extends AutoScalingRequest.Builder, SdkPojo, CopyableBuilder<CreateLaunchConfigurationRequest.Builder,CreateLaunchConfigurationRequest>

  • Method Details

    • launchConfigurationName

      CreateLaunchConfigurationRequest.Builder launchConfigurationName(String launchConfigurationName)

      The name of the launch configuration. This name must be unique per Region per account.

      Parameters:
      launchConfigurationName - The name of the launch configuration. This name must be unique per Region per account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageId

      CreateLaunchConfigurationRequest.Builder imageId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • keyName

      CreateLaunchConfigurationRequest.Builder keyName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroups

      CreateLaunchConfigurationRequest.Builder securityGroups(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroups

      CreateLaunchConfigurationRequest.Builder securityGroups(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • classicLinkVPCId

      CreateLaunchConfigurationRequest.Builder classicLinkVPCId(String classicLinkVPCId)

      Available for backward compatibility.

      Parameters:
      classicLinkVPCId - Available for backward compatibility.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • classicLinkVPCSecurityGroups

      CreateLaunchConfigurationRequest.Builder classicLinkVPCSecurityGroups(Collection<String> classicLinkVPCSecurityGroups)

      Available for backward compatibility.

      Parameters:
      classicLinkVPCSecurityGroups - Available for backward compatibility.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • classicLinkVPCSecurityGroups

      CreateLaunchConfigurationRequest.Builder classicLinkVPCSecurityGroups(String... classicLinkVPCSecurityGroups)

      Available for backward compatibility.

      Parameters:
      classicLinkVPCSecurityGroups - Available for backward compatibility.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userData

      CreateLaunchConfigurationRequest.Builder userData(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • instanceId

      CreateLaunchConfigurationRequest.Builder instanceId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • instanceType

      CreateLaunchConfigurationRequest.Builder instanceType(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • kernelId

      CreateLaunchConfigurationRequest.Builder kernelId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • ramdiskId

      CreateLaunchConfigurationRequest.Builder ramdiskId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • blockDeviceMappings

      CreateLaunchConfigurationRequest.Builder blockDeviceMappings(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockDeviceMappings

      CreateLaunchConfigurationRequest.Builder blockDeviceMappings(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockDeviceMappings

      CreateLaunchConfigurationRequest.Builder blockDeviceMappings(Consumer<BlockDeviceMapping.Builder>... 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.

      This is a convenience method that creates an instance of the BlockDeviceMapping.Builder avoiding the need to create one manually via BlockDeviceMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to blockDeviceMappings(List<BlockDeviceMapping>).

      Parameters:
      blockDeviceMappings - a consumer that will call methods on BlockDeviceMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceMonitoring

      CreateLaunchConfigurationRequest.Builder instanceMonitoring(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • instanceMonitoring

      default CreateLaunchConfigurationRequest.Builder instanceMonitoring(Consumer<InstanceMonitoring.Builder> 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.

      This is a convenience method that creates an instance of the InstanceMonitoring.Builder avoiding the need to create one manually via InstanceMonitoring.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceMonitoring(InstanceMonitoring).

      Parameters:
      instanceMonitoring - a consumer that will call methods on InstanceMonitoring.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • spotPrice

      CreateLaunchConfigurationRequest.Builder spotPrice(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • iamInstanceProfile

      CreateLaunchConfigurationRequest.Builder iamInstanceProfile(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • ebsOptimized

      CreateLaunchConfigurationRequest.Builder ebsOptimized(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • associatePublicIpAddress

      CreateLaunchConfigurationRequest.Builder associatePublicIpAddress(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • placementTenancy

      CreateLaunchConfigurationRequest.Builder placementTenancy(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • metadataOptions

      CreateLaunchConfigurationRequest.Builder metadataOptions(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • metadataOptions

      default CreateLaunchConfigurationRequest.Builder metadataOptions(Consumer<InstanceMetadataOptions.Builder> metadataOptions)

      The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.

      This is a convenience method that creates an instance of the InstanceMetadataOptions.Builder avoiding the need to create one manually via InstanceMetadataOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metadataOptions(InstanceMetadataOptions).

      Parameters:
      metadataOptions - a consumer that will call methods on InstanceMetadataOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateLaunchConfigurationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateLaunchConfigurationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.