Class LaunchSpecification

java.lang.Object
software.amazon.awssdk.services.ec2.model.LaunchSpecification
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LaunchSpecification.Builder,LaunchSpecification>
@Generated("software.amazon.awssdk:codegen") public final class LaunchSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LaunchSpecification.Builder,LaunchSpecification>

Describes the launch specification for an instance.

See Also:

  • Method Details

    • userData

      public final String userData()

      The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.

      Returns:
      The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.

    • addressingType

      public final String addressingType()

      Deprecated.

      Returns:
      Deprecated.

    • 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.

      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.

    • ebsOptimized

      public final Boolean ebsOptimized()

      Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

      Default: false

      Returns:
      Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

      Default: false

    • iamInstanceProfile

      public final IamInstanceProfileSpecification iamInstanceProfile()

      The IAM instance profile.

      Returns:
      The IAM instance profile.

    • imageId

      public final String imageId()

      The ID of the AMI.

      Returns:
      The ID of the AMI.

    • instanceType

      public final InstanceType instanceType()

      The instance type. Only one instance type can be specified.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The instance type. Only one instance type can be specified.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The instance type. Only one instance type can be specified.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The instance type. Only one instance type can be specified.
      See Also:

    • kernelId

      public final String kernelId()

      The ID of the kernel.

      Returns:
      The ID of the kernel.

    • keyName

      public final String keyName()

      The name of the key pair.

      Returns:
      The name of the key pair.

    • hasNetworkInterfaces

      public final boolean hasNetworkInterfaces()
      For responses, this returns true if the service returned a value for the NetworkInterfaces 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.

    • networkInterfaces

      public final List<InstanceNetworkInterfaceSpecification> networkInterfaces()

      The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

      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 hasNetworkInterfaces() method.

      Returns:
      The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

    • placement

      public final SpotPlacement placement()

      The placement information for the instance.

      Returns:
      The placement information for the instance.

    • ramdiskId

      public final String ramdiskId()

      The ID of the RAM disk.

      Returns:
      The ID of the RAM disk.

    • subnetId

      public final String subnetId()

      The ID of the subnet in which to launch the instance.

      Returns:
      The ID of the subnet in which to launch the instance.

    • 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<GroupIdentifier> securityGroups()

      The IDs of the security groups.

      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:
      The IDs of the security groups.

    • monitoring

      public final RunInstancesMonitoringEnabled monitoring()
      Returns the value of the Monitoring property for this object.
      Returns:
      The value of the Monitoring property for this object.

    • toBuilder

      public LaunchSpecification.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LaunchSpecification.Builder,LaunchSpecification>
      Returns:
      a builder for type T

    • builder

      public static LaunchSpecification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LaunchSpecification.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.