com.amazonaws.services.sagemaker.model

Class UserSettings

java.lang.Object

com.amazonaws.services.sagemaker.model.UserSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

A collection of settings.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserSettings()

Method Summary

Modifier and Type	Method and Description
UserSettings	clone()
boolean	equals(Object obj)
String	getExecutionRole() The execution role for the user.
JupyterServerAppSettings	getJupyterServerAppSettings() The Jupyter server's app settings.
KernelGatewayAppSettings	getKernelGatewayAppSettings() The kernel gateway app settings.
List<String>	getSecurityGroups() The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
SharingSettings	getSharingSettings() The sharing settings.
TensorBoardAppSettings	getTensorBoardAppSettings() The TensorBoard app settings.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setExecutionRole(String executionRole) The execution role for the user.
void	setJupyterServerAppSettings(JupyterServerAppSettings jupyterServerAppSettings) The Jupyter server's app settings.
void	setKernelGatewayAppSettings(KernelGatewayAppSettings kernelGatewayAppSettings) The kernel gateway app settings.
void	setSecurityGroups(Collection<String> securityGroups) The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
void	setSharingSettings(SharingSettings sharingSettings) The sharing settings.
void	setTensorBoardAppSettings(TensorBoardAppSettings tensorBoardAppSettings) The TensorBoard app settings.
String	toString() Returns a string representation of this object.
UserSettings	withExecutionRole(String executionRole) The execution role for the user.
UserSettings	withJupyterServerAppSettings(JupyterServerAppSettings jupyterServerAppSettings) The Jupyter server's app settings.
UserSettings	withKernelGatewayAppSettings(KernelGatewayAppSettings kernelGatewayAppSettings) The kernel gateway app settings.
UserSettings	withSecurityGroups(Collection<String> securityGroups) The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
UserSettings	withSecurityGroups(String... securityGroups) The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
UserSettings	withSharingSettings(SharingSettings sharingSettings) The sharing settings.
UserSettings	withTensorBoardAppSettings(TensorBoardAppSettings tensorBoardAppSettings) The TensorBoard app settings.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserSettings

public UserSettings()

Method Detail

setExecutionRole

public void setExecutionRole(String executionRole)

The execution role for the user.

Parameters:

executionRole - The execution role for the user.

getExecutionRole

public String getExecutionRole()

The execution role for the user.

Returns:

The execution role for the user.

withExecutionRole

public UserSettings withExecutionRole(String executionRole)

The execution role for the user.

Parameters:

executionRole - The execution role for the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSecurityGroups

public List<String> getSecurityGroups()

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

Returns:

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

setSecurityGroups

public void setSecurityGroups(Collection<String> securityGroups)

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

Parameters:

securityGroups - The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

withSecurityGroups

public UserSettings withSecurityGroups(String... securityGroups)

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroups(java.util.Collection) or withSecurityGroups(java.util.Collection) if you want to override the existing values.

Parameters:

securityGroups - The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSecurityGroups

public UserSettings withSecurityGroups(Collection<String> securityGroups)

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

Parameters:

securityGroups - The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSharingSettings

public void setSharingSettings(SharingSettings sharingSettings)

The sharing settings.

Parameters:

sharingSettings - The sharing settings.

getSharingSettings

public SharingSettings getSharingSettings()

The sharing settings.

Returns:

The sharing settings.

withSharingSettings

public UserSettings withSharingSettings(SharingSettings sharingSettings)

The sharing settings.

Parameters:

sharingSettings - The sharing settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

setJupyterServerAppSettings

public void setJupyterServerAppSettings(JupyterServerAppSettings jupyterServerAppSettings)

The Jupyter server's app settings.

Parameters:

jupyterServerAppSettings - The Jupyter server's app settings.

getJupyterServerAppSettings

public JupyterServerAppSettings getJupyterServerAppSettings()

The Jupyter server's app settings.

Returns:

The Jupyter server's app settings.

withJupyterServerAppSettings

public UserSettings withJupyterServerAppSettings(JupyterServerAppSettings jupyterServerAppSettings)

The Jupyter server's app settings.

Parameters:

jupyterServerAppSettings - The Jupyter server's app settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKernelGatewayAppSettings

public void setKernelGatewayAppSettings(KernelGatewayAppSettings kernelGatewayAppSettings)

The kernel gateway app settings.

Parameters:

kernelGatewayAppSettings - The kernel gateway app settings.

getKernelGatewayAppSettings

public KernelGatewayAppSettings getKernelGatewayAppSettings()

The kernel gateway app settings.

Returns:

The kernel gateway app settings.

withKernelGatewayAppSettings

public UserSettings withKernelGatewayAppSettings(KernelGatewayAppSettings kernelGatewayAppSettings)

The kernel gateway app settings.

Parameters:

kernelGatewayAppSettings - The kernel gateway app settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTensorBoardAppSettings

public void setTensorBoardAppSettings(TensorBoardAppSettings tensorBoardAppSettings)

The TensorBoard app settings.

Parameters:

tensorBoardAppSettings - The TensorBoard app settings.

getTensorBoardAppSettings

public TensorBoardAppSettings getTensorBoardAppSettings()

The TensorBoard app settings.

Returns:

The TensorBoard app settings.

withTensorBoardAppSettings

public UserSettings withTensorBoardAppSettings(TensorBoardAppSettings tensorBoardAppSettings)

The TensorBoard app settings.

Parameters:

tensorBoardAppSettings - The TensorBoard app settings.

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