com.amazonaws.services.sagemaker.model

Class SharingSettings

java.lang.Object

com.amazonaws.services.sagemaker.model.SharingSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn't allowed.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SharingSettings()

Method Summary

Modifier and Type	Method and Description
SharingSettings	clone()
boolean	equals(Object obj)
String	getNotebookOutputOption() Whether to include the notebook cell output when sharing the notebook.
String	getS3KmsKeyId() When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
String	getS3OutputPath() When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setNotebookOutputOption(String notebookOutputOption) Whether to include the notebook cell output when sharing the notebook.
void	setS3KmsKeyId(String s3KmsKeyId) When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
void	setS3OutputPath(String s3OutputPath) When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
String	toString() Returns a string representation of this object.
SharingSettings	withNotebookOutputOption(NotebookOutputOption notebookOutputOption) Whether to include the notebook cell output when sharing the notebook.
SharingSettings	withNotebookOutputOption(String notebookOutputOption) Whether to include the notebook cell output when sharing the notebook.
SharingSettings	withS3KmsKeyId(String s3KmsKeyId) When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
SharingSettings	withS3OutputPath(String s3OutputPath) When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SharingSettings

public SharingSettings()

Method Detail

setNotebookOutputOption

public void setNotebookOutputOption(String notebookOutputOption)

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Parameters:

notebookOutputOption - Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

See Also:

NotebookOutputOption

getNotebookOutputOption

public String getNotebookOutputOption()

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Returns:

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

See Also:

NotebookOutputOption

withNotebookOutputOption

public SharingSettings withNotebookOutputOption(String notebookOutputOption)

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Parameters:

notebookOutputOption - Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Returns:

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

See Also:

NotebookOutputOption

withNotebookOutputOption

public SharingSettings withNotebookOutputOption(NotebookOutputOption notebookOutputOption)

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Parameters:

notebookOutputOption - Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Returns:

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

See Also:

NotebookOutputOption

setS3OutputPath

public void setS3OutputPath(String s3OutputPath)

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Parameters:

s3OutputPath - When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

getS3OutputPath

public String getS3OutputPath()

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Returns:

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

withS3OutputPath

public SharingSettings withS3OutputPath(String s3OutputPath)

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Parameters:

s3OutputPath - When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Returns:

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

setS3KmsKeyId

public void setS3KmsKeyId(String s3KmsKeyId)

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

Parameters:

s3KmsKeyId - When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

getS3KmsKeyId

public String getS3KmsKeyId()

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

Returns:

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

withS3KmsKeyId

public SharingSettings withS3KmsKeyId(String s3KmsKeyId)

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

Parameters:

s3KmsKeyId - When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

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