Interface RunMicrovmRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RunMicrovmRequest.Builder,RunMicrovmRequest>, LambdaMicrovmsRequest.Builder, SdkBuilder<RunMicrovmRequest.Builder,RunMicrovmRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RunMicrovmRequest
@Mutable @NotThreadSafe public static interface RunMicrovmRequest.Builder extends LambdaMicrovmsRequest.Builder, SdkPojo, CopyableBuilder<RunMicrovmRequest.Builder,RunMicrovmRequest>

  • Method Details

    • ingressNetworkConnectors

      RunMicrovmRequest.Builder ingressNetworkConnectors(Collection<String> ingressNetworkConnectors)

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

      Parameters:
      ingressNetworkConnectors - The list of ingress network connectors to configure for the MicroVM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ingressNetworkConnectors

      RunMicrovmRequest.Builder ingressNetworkConnectors(String... ingressNetworkConnectors)

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

      Parameters:
      ingressNetworkConnectors - The list of ingress network connectors to configure for the MicroVM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • egressNetworkConnectors

      RunMicrovmRequest.Builder egressNetworkConnectors(Collection<String> egressNetworkConnectors)

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

      Parameters:
      egressNetworkConnectors - The list of egress network connectors to configure for the MicroVM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • egressNetworkConnectors

      RunMicrovmRequest.Builder egressNetworkConnectors(String... egressNetworkConnectors)

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

      Parameters:
      egressNetworkConnectors - The list of egress network connectors to configure for the MicroVM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageIdentifier

      RunMicrovmRequest.Builder imageIdentifier(String imageIdentifier)

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

      Parameters:
      imageIdentifier - The identifier (ARN or ID) of the MicroVM image to run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageVersion

      RunMicrovmRequest.Builder imageVersion(String imageVersion)

      The version of the MicroVM image to run.

      Parameters:
      imageVersion - The version of the MicroVM image to run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionRoleArn

      RunMicrovmRequest.Builder executionRoleArn(String executionRoleArn)

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

      Parameters:
      executionRoleArn - The ARN of the IAM role to be assumed by the MicroVM during execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idlePolicy

      RunMicrovmRequest.Builder idlePolicy(IdlePolicy idlePolicy)

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

      Parameters:
      idlePolicy - Configuration to control auto-suspend and auto-resume behavior.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idlePolicy

      default RunMicrovmRequest.Builder idlePolicy(Consumer<IdlePolicy.Builder> idlePolicy)

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

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

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

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

    • logging

      RunMicrovmRequest.Builder logging(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.

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

    • logging

      default RunMicrovmRequest.Builder logging(Consumer<Logging.Builder> 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.

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

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

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

    • runHookPayload

      RunMicrovmRequest.Builder runHookPayload(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.

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

    • maximumDurationInSeconds

      RunMicrovmRequest.Builder maximumDurationInSeconds(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).

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

    • clientToken

      RunMicrovmRequest.Builder clientToken(String clientToken)

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

      Parameters:
      clientToken - A unique, case-sensitive identifier you provide to ensure the idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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