Class LaunchParameters

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

The parameters for launching Amazon EC2 instances in a capacity provider.

See Also:

  • Method Details

    • operatingSystem

      public final OperatingSystem operatingSystem()

      The operating system and CPU architecture for the instances.

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

      Returns:
      The operating system and CPU architecture for the instances.
      See Also:

    • operatingSystemAsString

      public final String operatingSystemAsString()

      The operating system and CPU architecture for the instances.

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

      Returns:
      The operating system and CPU architecture for the instances.
      See Also:

    • instanceRequirements

      public final InstanceRequirements instanceRequirements()

      The requirements that determine which instance types can be launched.

      Returns:
      The requirements that determine which instance types can be launched.

    • hasEphemeralVolumes

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

    • ephemeralVolumes

      public final List<EphemeralBlockDeviceMapping> ephemeralVolumes()

      The block device mappings for instance store (ephemeral) volumes. You can specify up to five mappings.

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

      Returns:
      The block device mappings for instance store (ephemeral) volumes. You can specify up to five mappings.

    • monitoring

      public final Monitoring monitoring()

      The monitoring level for the instances.

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

      Returns:
      The monitoring level for the instances.
      See Also:

    • monitoringAsString

      public final String monitoringAsString()

      The monitoring level for the instances.

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

      Returns:
      The monitoring level for the instances.
      See Also:

    • hasLicenseSpecifications

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

    • licenseSpecifications

      public final List<LicenseSpecification> licenseSpecifications()

      The license configurations to associate with the instances. You can specify up to five configurations.

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

      Returns:
      The license configurations to associate with the instances. You can specify up to five configurations.

    • capacityReservationSpecification

      public final CapacityReservationSpecification capacityReservationSpecification()

      The Capacity Reservation targeting option for the instances.

      Returns:
      The Capacity Reservation targeting option for the instances.

    • sshKeyName

      public final String sshKeyName()

      The name of the SSH key pair to configure on the instances for SSH connectivity.

      Returns:
      The name of the SSH key pair to configure on the instances for SSH connectivity.

    • instanceProfileArn

      public final String instanceProfileArn()

      The Amazon Resource Name (ARN) of the IAM instance profile to associate with launched instances. If provided, this overrides the default instance profile.

      Returns:
      The Amazon Resource Name (ARN) of the IAM instance profile to associate with launched instances. If provided, this overrides the default instance profile.

    • hasPropagatedTags

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

    • propagatedTags

      public final Map<String,String> propagatedTags()

      The tags to propagate to all Amazon EC2 resources (instances, volumes, and network interfaces) that the capacity provider creates.

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

      Returns:
      The tags to propagate to all Amazon EC2 resources (instances, volumes, and network interfaces) that the capacity provider creates.

    • toBuilder

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

    • builder

      public static LaunchParameters.Builder builder()

    • serializableBuilderClass

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