Class SharingSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SharingSettings.Builder,
SharingSettings>
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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SharingSettings.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final NotebookOutputOption
Whether to include the notebook cell output when sharing the notebook.final String
Whether to include the notebook cell output when sharing the notebook.final String
WhenNotebookOutputOption
isAllowed
, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.final String
WhenNotebookOutputOption
isAllowed
, the Amazon S3 bucket used to store the shared notebook snapshots.static Class
<? extends SharingSettings.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
notebookOutputOption
Whether to include the notebook cell output when sharing the notebook. The default is
Disabled
.If the service returns an enum value that is not available in the current SDK version,
notebookOutputOption
will returnNotebookOutputOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnotebookOutputOptionAsString()
.- Returns:
- Whether to include the notebook cell output when sharing the notebook. The default is
Disabled
. - See Also:
-
notebookOutputOptionAsString
Whether to include the notebook cell output when sharing the notebook. The default is
Disabled
.If the service returns an enum value that is not available in the current SDK version,
notebookOutputOption
will returnNotebookOutputOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnotebookOutputOptionAsString()
.- Returns:
- Whether to include the notebook cell output when sharing the notebook. The default is
Disabled
. - See Also:
-
s3OutputPath
When
NotebookOutputOption
isAllowed
, the Amazon S3 bucket used to store the shared notebook snapshots.- Returns:
- When
NotebookOutputOption
isAllowed
, the Amazon S3 bucket used to store the shared notebook snapshots.
-
s3KmsKeyId
When
NotebookOutputOption
isAllowed
, 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
isAllowed
, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SharingSettings.Builder,
SharingSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-