Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.Types.SharingSettings

Description

Documentation

data SharingSettings Source #

Specifies options for sharing 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: newSharingSettings smart constructor.

Constructors

SharingSettings'

Fields

s3KmsKeyId :: Maybe Text
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.
s3OutputPath :: Maybe Text
When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
notebookOutputOption :: Maybe NotebookOutputOption
Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Instances

Instances details

Eq SharingSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.SharingSettings Methods (==) :: SharingSettings -> SharingSettings -> Bool # (/=) :: SharingSettings -> SharingSettings -> Bool #
Read SharingSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.SharingSettings Methods readsPrec :: Int -> ReadS SharingSettings # readList :: ReadS [SharingSettings] # readPrec :: ReadPrec SharingSettings # readListPrec :: ReadPrec [SharingSettings] #
Show SharingSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.SharingSettings Methods showsPrec :: Int -> SharingSettings -> ShowS # show :: SharingSettings -> String # showList :: [SharingSettings] -> ShowS #
Generic SharingSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.SharingSettings Associated Types type Rep SharingSettings :: Type -> Type # Methods from :: SharingSettings -> Rep SharingSettings x # to :: Rep SharingSettings x -> SharingSettings #
NFData SharingSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.SharingSettings Methods rnf :: SharingSettings -> () #
Hashable SharingSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.SharingSettings Methods hashWithSalt :: Int -> SharingSettings -> Int # hash :: SharingSettings -> Int #
ToJSON SharingSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.SharingSettings Methods toJSON :: SharingSettings -> Value # toEncoding :: SharingSettings -> Encoding # toJSONList :: [SharingSettings] -> Value # toEncodingList :: [SharingSettings] -> Encoding #
FromJSON SharingSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.SharingSettings Methods parseJSON :: Value -> Parser SharingSettings # parseJSONList :: Value -> Parser [SharingSettings] #
type Rep SharingSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.SharingSettings type Rep SharingSettings = D1 ('MetaData "SharingSettings" "Amazonka.SageMaker.Types.SharingSettings" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "SharingSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3KmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "s3OutputPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "notebookOutputOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotebookOutputOption)))))

newSharingSettings :: SharingSettings Source #

Create a value of SharingSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:s3KmsKeyId:SharingSettings', sharingSettings_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.

$sel:s3OutputPath:SharingSettings', sharingSettings_s3OutputPath - When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

$sel:notebookOutputOption:SharingSettings', sharingSettings_notebookOutputOption - Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

sharingSettings_s3KmsKeyId :: Lens' SharingSettings (Maybe Text) Source #

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_s3OutputPath :: Lens' SharingSettings (Maybe Text) Source #

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

sharingSettings_notebookOutputOption :: Lens' SharingSettings (Maybe NotebookOutputOption) Source #

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