Class: AWSCDK::Sagemaker::CfnDomain::SharingSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_domain.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.



2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'sagemaker/cfn_domain.rb', line 2058

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:



2073
2074
2075
 
# File 'sagemaker/cfn_domain.rb', line 2073

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:



2078
2079
2080
 
# File 'sagemaker/cfn_domain.rb', line 2078

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:



2083
2084
2085
 
# File 'sagemaker/cfn_domain.rb', line 2083

def s3_output_path
  @s3_output_path
end

Class Method Details

.jsii_properties ⇒ Object 



2085
2086
2087
2088
2089
2090
2091
 
# File 'sagemaker/cfn_domain.rb', line 2085

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

Instance Method Details

#to_jsii ⇒ Object 



2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'sagemaker/cfn_domain.rb', line 2093

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