Class RunMicrovmRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lambdamicrovms.model.LambdaMicrovmsRequest
software.amazon.awssdk.services.lambdamicrovms.model.RunMicrovmRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RunMicrovmRequest.Builder,RunMicrovmRequest>
@Generated("software.amazon.awssdk:codegen") public final class RunMicrovmRequest extends LambdaMicrovmsRequest implements ToCopyableBuilder<RunMicrovmRequest.Builder,RunMicrovmRequest>

  • Method Details

    • hasIngressNetworkConnectors

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

    • ingressNetworkConnectors

      public final List<String> ingressNetworkConnectors()

      The list of ingress network connectors to configure for the MicroVM.

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

      Returns:
      The list of ingress network connectors to configure for the MicroVM.

    • hasEgressNetworkConnectors

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

    • egressNetworkConnectors

      public final List<String> egressNetworkConnectors()

      The list of egress network connectors to configure for the MicroVM.

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

      Returns:
      The list of egress network connectors to configure for the MicroVM.

    • imageIdentifier

      public final String imageIdentifier()

      The identifier (ARN or ID) of the MicroVM image to run.

      Returns:
      The identifier (ARN or ID) of the MicroVM image to run.

    • imageVersion

      public final String imageVersion()

      The version of the MicroVM image to run.

      Returns:
      The version of the MicroVM image to run.

    • executionRoleArn

      public final String executionRoleArn()

      The ARN of the IAM role to be assumed by the MicroVM during execution.

      Returns:
      The ARN of the IAM role to be assumed by the MicroVM during execution.

    • idlePolicy

      public final IdlePolicy idlePolicy()

      Configuration to control auto-suspend and auto-resume behavior.

      Returns:
      Configuration to control auto-suspend and auto-resume behavior.

    • logging

      public final Logging logging()

      The logging configuration for this MicroVM instance. Specify {"cloudWatch": {"logGroup": "..."}} to stream application logs to a custom CloudWatch log group, or {"disabled": {}} to turn off logging.

      Returns:
      The logging configuration for this MicroVM instance. Specify {"cloudWatch": {"logGroup": "..."}} to stream application logs to a custom CloudWatch log group, or {"disabled": {}} to turn off logging.

    • runHookPayload

      public final String runHookPayload()

      Per-MicroVM initialization data delivered as the request body of the /run lifecycle hook. Use to pass tenant-specific configuration such as session IDs or secret references. Maximum: 16,384 bytes.

      Returns:
      Per-MicroVM initialization data delivered as the request body of the /run lifecycle hook. Use to pass tenant-specific configuration such as session IDs or secret references. Maximum: 16,384 bytes.

    • maximumDurationInSeconds

      public final Integer maximumDurationInSeconds()

      The maximum duration in seconds that the MicroVM can exist before being terminated by the platform. Valid range: 1–28,800 (8 hours).

      Returns:
      The maximum duration in seconds that the MicroVM can exist before being terminated by the platform. Valid range: 1–28,800 (8 hours).

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier you provide to ensure the idempotency of the request.

      Returns:
      A unique, case-sensitive identifier you provide to ensure the idempotency of the request.

    • toBuilder

      public RunMicrovmRequest.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<RunMicrovmRequest.Builder,RunMicrovmRequest>
      Specified by:
      toBuilder in class LambdaMicrovmsRequest
      Returns:
      a builder for type T

    • builder

      public static RunMicrovmRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RunMicrovmRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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