Interface StartSessionRequest.Builder

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

  • Method Details

    • name

      StartSessionRequest.Builder name(String name)

      An optional name for the session.

      Parameters:
      name - An optional name for the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterId

      StartSessionRequest.Builder clusterId(String clusterId)

      The ID of the cluster on which to start the session.

      Parameters:
      clusterId - The ID of the cluster on which to start the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionRoleArn

      StartSessionRequest.Builder executionRoleArn(String executionRoleArn)

      The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.

      Parameters:
      executionRoleArn - The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineConfigurations

      StartSessionRequest.Builder engineConfigurations(Collection<Configuration> engineConfigurations)

      The configuration overrides for the session. Only runtime configuration overrides are supported.

      Parameters:
      engineConfigurations - The configuration overrides for the session. Only runtime configuration overrides are supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineConfigurations

      StartSessionRequest.Builder engineConfigurations(Configuration... engineConfigurations)

      The configuration overrides for the session. Only runtime configuration overrides are supported.

      Parameters:
      engineConfigurations - The configuration overrides for the session. Only runtime configuration overrides are supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineConfigurations

      StartSessionRequest.Builder engineConfigurations(Consumer<Configuration.Builder>... engineConfigurations)

      The configuration overrides for the session. Only runtime configuration overrides are supported.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to engineConfigurations(List<Configuration>).

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

    • monitoringConfiguration

      StartSessionRequest.Builder monitoringConfiguration(SessionMonitoringConfiguration monitoringConfiguration)

      The monitoring configuration that controls where session logs are published, such as Amazon S3, CloudWatch, or managed logging.

      Parameters:
      monitoringConfiguration - The monitoring configuration that controls where session logs are published, such as Amazon S3, CloudWatch, or managed logging.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • monitoringConfiguration

      default StartSessionRequest.Builder monitoringConfiguration(Consumer<SessionMonitoringConfiguration.Builder> monitoringConfiguration)

      The monitoring configuration that controls where session logs are published, such as Amazon S3, CloudWatch, or managed logging.

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

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

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

    • sessionIdleTimeoutInMinutes

      StartSessionRequest.Builder sessionIdleTimeoutInMinutes(Long sessionIdleTimeoutInMinutes)

      The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR EC2 automatically terminates it.

      Parameters:
      sessionIdleTimeoutInMinutes - The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR EC2 automatically terminates it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientRequestToken

      StartSessionRequest.Builder clientRequestToken(String clientRequestToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client request token, the service returns the original response without performing the operation again.

      Parameters:
      clientRequestToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client request token, the service returns the original response without performing the operation again.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      StartSessionRequest.Builder tags(Collection<Tag> tags)

      The tags to assign to the session.

      Parameters:
      tags - The tags to assign to the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      StartSessionRequest.Builder tags(Tag... tags)

      The tags to assign to the session.

      Parameters:
      tags - The tags to assign to the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      StartSessionRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags to assign to the session.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

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

    • overrideConfiguration

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

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