Class: AWSCDK::Sagemaker::CfnUserProfile::SharingSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_user_profile.rb

Overview

Specifies options when sharing an Amazon SageMaker Studio notebook.

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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(notebook_output_option: nil, s3_kms_key_id: nil, s3_output_path: nil) ⇒ SharingSettingsProperty

Returns a new instance of SharingSettingsProperty.

Parameters:

  • notebook_output_option (String, nil) (defaults to: nil) —

    Whether to include the notebook cell output when sharing the notebook.

  • s3_kms_key_id (String, nil) (defaults to: nil) —

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

  • s3_output_path (String, nil) (defaults to: nil) —

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



1519
1520
1521
1522
1523
1524
1525
1526
 
# File 'sagemaker/cfn_user_profile.rb', line 1519

def initialize(notebook_output_option: nil, s3_kms_key_id: nil, s3_output_path: nil)
  @notebook_output_option = notebook_output_option
  Jsii::Type.check_type(@notebook_output_option, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notebookOutputOption") unless @notebook_output_option.nil?
  @s3_kms_key_id = s3_kms_key_id
  Jsii::Type.check_type(@s3_kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3KmsKeyId") unless @s3_kms_key_id.nil?
  @s3_output_path = s3_output_path
  Jsii::Type.check_type(@s3_output_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3OutputPath") unless @s3_output_path.nil?
end

Instance Attribute Details

#notebook_output_option ⇒ String? (readonly)

Whether to include the notebook cell output when sharing the notebook.

The default is Disabled .

Returns:

  • (String, nil)

See Also:



1534
1535
1536
 
# File 'sagemaker/cfn_user_profile.rb', line 1534

def notebook_output_option
  @notebook_output_option
end

#s3_kms_key_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1539
1540
1541
 
# File 'sagemaker/cfn_user_profile.rb', line 1539

def s3_kms_key_id
  @s3_kms_key_id
end

#s3_output_path ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1544
1545
1546
 
# File 'sagemaker/cfn_user_profile.rb', line 1544

def s3_output_path
  @s3_output_path
end

Class Method Details

.jsii_properties ⇒ Object 



1546
1547
1548
1549
1550
1551
1552
 
# File 'sagemaker/cfn_user_profile.rb', line 1546

def self.jsii_properties
  {
    :notebook_output_option => "notebookOutputOption",
    :s3_kms_key_id => "s3KmsKeyId",
    :s3_output_path => "s3OutputPath",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1554
1555
1556
1557
1558
1559
1560
1561
1562
 
# File 'sagemaker/cfn_user_profile.rb', line 1554

def to_jsii
  result = {}
  result.merge!({
    "notebookOutputOption" => @notebook_output_option,
    "s3KmsKeyId" => @s3_kms_key_id,
    "s3OutputPath" => @s3_output_path,
  })
  result.compact
end