Package software.amazon.awssdk.services.ec2.model

Class ScheduledInstancesLaunchSpecification

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

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

See Also:

  • Method Details

    • 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<ScheduledInstancesBlockDeviceMapping> 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 instances are 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 instances are 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 ScheduledInstancesIamInstanceProfile iamInstanceProfile()

      The IAM instance profile.

      Returns:
      The IAM instance profile.

    • imageId

      public final String imageId()

      The ID of the Amazon Machine Image (AMI).

      Returns:
      The ID of the Amazon Machine Image (AMI).

    • instanceType

      public final String instanceType()

      The instance type.

      Returns:
      The instance type.

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

    • monitoring

      public final ScheduledInstancesMonitoring monitoring()

      Enable or disable monitoring for the instances.

      Returns:
      Enable or disable monitoring for the instances.

    • 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<ScheduledInstancesNetworkInterface> networkInterfaces()

      The network interfaces.

      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.

    • placement

      public final ScheduledInstancesPlacement placement()

      The placement information.

      Returns:
      The placement information.

    • ramdiskId

      public final String ramdiskId()

      The ID of the RAM disk.

      Returns:
      The ID of the RAM disk.

    • hasSecurityGroupIds

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

    • securityGroupIds

      public final List<String> securityGroupIds()

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

      Returns:
      The IDs of the security groups.

    • subnetId

      public final String subnetId()

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

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

    • userData

      public final String userData()

      The base64-encoded MIME user data.

      Returns:
      The base64-encoded MIME user data.

    • toBuilder

      public ScheduledInstancesLaunchSpecification.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<ScheduledInstancesLaunchSpecification.Builder,ScheduledInstancesLaunchSpecification>
      Returns:
      a builder for type T

    • builder

      public static ScheduledInstancesLaunchSpecification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ScheduledInstancesLaunchSpecification.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.