EngineConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.athena.model.EngineConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EngineConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains data processing unit (DPU) configuration settings and parameter mappings for a notebook engine.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EngineConfiguration()

Constructors
Constructor and Description
`EngineConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EngineConfiguration`	`addAdditionalConfigsEntry(String key, String value)` Add a single AdditionalConfigs entry
`EngineConfiguration`	`clearAdditionalConfigsEntries()` Removes all the entries added into AdditionalConfigs.
`EngineConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAdditionalConfigs()` Contains additional notebook engine `MAP<string, string>` parameter mappings in the form of key-value pairs.
`Integer`	`getCoordinatorDpuSize()` The number of DPUs to use for the coordinator.
`Integer`	`getDefaultExecutorDpuSize()` The default number of DPUs to use for executors.
`Integer`	`getMaxConcurrentDpus()` The maximum number of DPUs that can run concurrently.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalConfigs(Map<String,String> additionalConfigs)` Contains additional notebook engine `MAP<string, string>` parameter mappings in the form of key-value pairs.
`void`	`setCoordinatorDpuSize(Integer coordinatorDpuSize)` The number of DPUs to use for the coordinator.
`void`	`setDefaultExecutorDpuSize(Integer defaultExecutorDpuSize)` The default number of DPUs to use for executors.
`void`	`setMaxConcurrentDpus(Integer maxConcurrentDpus)` The maximum number of DPUs that can run concurrently.
`String`	`toString()` Returns a string representation of this object.
`EngineConfiguration`	`withAdditionalConfigs(Map<String,String> additionalConfigs)` Contains additional notebook engine `MAP<string, string>` parameter mappings in the form of key-value pairs.
`EngineConfiguration`	`withCoordinatorDpuSize(Integer coordinatorDpuSize)` The number of DPUs to use for the coordinator.
`EngineConfiguration`	`withDefaultExecutorDpuSize(Integer defaultExecutorDpuSize)` The default number of DPUs to use for executors.
`EngineConfiguration`	`withMaxConcurrentDpus(Integer maxConcurrentDpus)` The maximum number of DPUs that can run concurrently.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EngineConfiguration
```
public EngineConfiguration()
```
- Method Detail
  - setCoordinatorDpuSize
```
public void setCoordinatorDpuSize(Integer coordinatorDpuSize)
```
    The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session.
    
    Parameters:
    
    coordinatorDpuSize - The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session.
  - getCoordinatorDpuSize
```
public Integer getCoordinatorDpuSize()
```
    The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session.
    
    Returns:
    
    The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session.
  - withCoordinatorDpuSize
```
public EngineConfiguration withCoordinatorDpuSize(Integer coordinatorDpuSize)
```
    The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session.
    
    Parameters:
    
    coordinatorDpuSize - The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxConcurrentDpus
```
public void setMaxConcurrentDpus(Integer maxConcurrentDpus)
```
    The maximum number of DPUs that can run concurrently.
    
    Parameters:
    
    maxConcurrentDpus - The maximum number of DPUs that can run concurrently.
  - getMaxConcurrentDpus
```
public Integer getMaxConcurrentDpus()
```
    The maximum number of DPUs that can run concurrently.
    
    Returns:
    
    The maximum number of DPUs that can run concurrently.
  - withMaxConcurrentDpus
```
public EngineConfiguration withMaxConcurrentDpus(Integer maxConcurrentDpus)
```
    The maximum number of DPUs that can run concurrently.
    
    Parameters:
    
    maxConcurrentDpus - The maximum number of DPUs that can run concurrently.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultExecutorDpuSize
```
public void setDefaultExecutorDpuSize(Integer defaultExecutorDpuSize)
```
    The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena.
    
    Parameters:
    
    defaultExecutorDpuSize - The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena.
  - getDefaultExecutorDpuSize
```
public Integer getDefaultExecutorDpuSize()
```
    The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena.
    
    Returns:
    
    The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena.
  - withDefaultExecutorDpuSize
```
public EngineConfiguration withDefaultExecutorDpuSize(Integer defaultExecutorDpuSize)
```
    The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena.
    
    Parameters:
    
    defaultExecutorDpuSize - The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdditionalConfigs
```
public Map<String,String> getAdditionalConfigs()
```
    Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
    
    Returns:
    
    Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
  - setAdditionalConfigs
```
public void setAdditionalConfigs(Map<String,String> additionalConfigs)
```
    Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
    
    Parameters:
    
    additionalConfigs - Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
  - withAdditionalConfigs
```
public EngineConfiguration withAdditionalConfigs(Map<String,String> additionalConfigs)
```
    Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
    
    Parameters:
    
    additionalConfigs - Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAdditionalConfigsEntry
```
public EngineConfiguration addAdditionalConfigsEntry(String key,
                                                     String value)
```
    Add a single AdditionalConfigs entry
    
    See Also:
    
    withAdditionalConfigs(java.util.Map<java.lang.String, java.lang.String>)
  - clearAdditionalConfigsEntries
```
public EngineConfiguration clearAdditionalConfigsEntries()
```
    Removes all the entries added into AdditionalConfigs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EngineConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class EngineConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EngineConfiguration

Method Detail

setCoordinatorDpuSize

getCoordinatorDpuSize

withCoordinatorDpuSize

setMaxConcurrentDpus

getMaxConcurrentDpus

withMaxConcurrentDpus

setDefaultExecutorDpuSize

getDefaultExecutorDpuSize

withDefaultExecutorDpuSize

getAdditionalConfigs

setAdditionalConfigs

withAdditionalConfigs

addAdditionalConfigsEntry

clearAdditionalConfigsEntries

toString

equals

hashCode

clone

marshall