Class: AWSCDK::Sagemaker::CfnUserProfileProps

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

Overview

Properties for defining a CfnUserProfile.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_id:, user_profile_name:, single_sign_on_user_identifier: nil, single_sign_on_user_value: nil, tags: nil, user_settings: nil) ⇒ CfnUserProfileProps

Returns a new instance of CfnUserProfileProps.

Parameters:

  • domain_id (String, AWSCDK::Interfaces::AWSSagemaker::IDomainRef) —

    The domain ID.

  • user_profile_name (String) —

    The user profile name.

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

    A specifier for the type of value specified in SingleSignOnUserValue.

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

    The username of the associated AWS Single Sign-On User for this UserProfile.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.

  • user_settings (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnUserProfile::UserSettingsProperty, nil) (defaults to: nil) —

    A collection of settings that apply to users of Amazon SageMaker Studio.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'sagemaker/cfn_user_profile_props.rb', line 15

def initialize(domain_id:, user_profile_name:, single_sign_on_user_identifier: nil, single_sign_on_user_value: nil, tags: nil, user_settings: nil)
  @domain_id = domain_id
  Jsii::Type.check_type(@domain_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zYWdlbWFrZXIuSURvbWFpblJlZiJ9XX19")), "domainId")
  @user_profile_name = 
  Jsii::Type.check_type(@user_profile_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userProfileName")
  @single_sign_on_user_identifier = single_sign_on_user_identifier
  Jsii::Type.check_type(@single_sign_on_user_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "singleSignOnUserIdentifier") unless @single_sign_on_user_identifier.nil?
  @single_sign_on_user_value = single_sign_on_user_value
  Jsii::Type.check_type(@single_sign_on_user_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "singleSignOnUserValue") unless @single_sign_on_user_value.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @user_settings = .is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnUserProfile::UserSettingsProperty.new(**.transform_keys(&:to_sym)) : 
  Jsii::Type.check_type(@user_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuVXNlclByb2ZpbGUuVXNlclNldHRpbmdzUHJvcGVydHkifV19fQ==")), "userSettings") unless @user_settings.nil?
end

Instance Attribute Details

#domain_id ⇒ String, AWSCDK::Interfaces::AWSSagemaker::IDomainRef (readonly)

The domain ID.

Returns:

See Also:



34
35
36
 
# File 'sagemaker/cfn_user_profile_props.rb', line 34

def domain_id
  @domain_id
end

#single_sign_on_user_identifier ⇒ String? (readonly)

A specifier for the type of value specified in SingleSignOnUserValue.

Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO , this field is required. If the Domain's AuthMode is not SSO , this field cannot be specified.

Returns:

  • (String, nil)

See Also:



46
47
48
 
# File 'sagemaker/cfn_user_profile_props.rb', line 46

def single_sign_on_user_identifier
  @single_sign_on_user_identifier
end

#single_sign_on_user_value ⇒ String? (readonly)

The username of the associated AWS Single Sign-On User for this UserProfile.

If the Domain's AuthMode is SSO , this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO , this field cannot be specified.

Returns:

  • (String, nil)

See Also:



53
54
55
 
# File 'sagemaker/cfn_user_profile_props.rb', line 53

def single_sign_on_user_value
  @single_sign_on_user_value
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to this resource.

Tags that you specify for the User Profile are also added to all apps that the User Profile launches.

For more information, see Tag .

Returns:

See Also:



62
63
64
 
# File 'sagemaker/cfn_user_profile_props.rb', line 62

def tags
  @tags
end

#user_profile_name ⇒ String (readonly)

The user profile name.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'sagemaker/cfn_user_profile_props.rb', line 39

def 
  @user_profile_name
end

#user_settings ⇒ AWSCDK::IResolvable, ... (readonly)

A collection of settings that apply to users of Amazon SageMaker Studio.

Returns:

See Also:



67
68
69
 
# File 'sagemaker/cfn_user_profile_props.rb', line 67

def 
  @user_settings
end

Class Method Details

.jsii_properties ⇒ Object 



69
70
71
72
73
74
75
76
77
78
 
# File 'sagemaker/cfn_user_profile_props.rb', line 69

def self.jsii_properties
  {
    :domain_id => "domainId",
    :user_profile_name => "userProfileName",
    :single_sign_on_user_identifier => "singleSignOnUserIdentifier",
    :single_sign_on_user_value => "singleSignOnUserValue",
    :tags => "tags",
    :user_settings => "userSettings",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'sagemaker/cfn_user_profile_props.rb', line 80

def to_jsii
  result = {}
  result.merge!({
    "domainId" => @domain_id,
    "userProfileName" => @user_profile_name,
    "singleSignOnUserIdentifier" => @single_sign_on_user_identifier,
    "singleSignOnUserValue" => @single_sign_on_user_value,
    "tags" => @tags,
    "userSettings" => @user_settings,
  })
  result.compact
end