Class: Aws::SageMaker::Types::CreateDomainRequest

Inherits:

Struct

Object
Struct
Aws::SageMaker::Types::CreateDomainRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-sagemaker/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#app_network_access_type ⇒ String

Specifies the VPC used for non-EFS traffic.
#app_security_group_management ⇒ String

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
#auth_mode ⇒ String

The mode of authentication that members use to access the domain.
#default_space_settings ⇒ Types::DefaultSpaceSettings

The default settings used to create a space.
#default_user_settings ⇒ Types::UserSettings

The default settings to use to create a user profile when UserSettings isn’t specified in the call to the CreateUserProfile API.
#domain_name ⇒ String

A name for the domain.
#domain_settings ⇒ Types::DomainSettings

A collection of Domain settings.
#home_efs_file_system_kms_key_id ⇒ String

Use KmsKeyId.
#kms_key_id ⇒ String

SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default.
#subnet_ids ⇒ Array<String>

The VPC subnets that the domain uses for communication.
#tags ⇒ Array<Types::Tag>

Tags to associated with the Domain.
#vpc_id ⇒ String

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Instance Attribute Details

#app_network_access_type ⇒ `String`

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
VpcOnly - All traffic is through the specified VPC and subnets

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 5828

class CreateDomainRequest < Struct.new(
  :domain_name,
  :auth_mode,
  :default_user_settings,
  :domain_settings,
  :subnet_ids,
  :vpc_id,
  :tags,
  :app_network_access_type,
  :home_efs_file_system_kms_key_id,
  :kms_key_id,
  :app_security_group_management,
  :default_space_settings)
  SENSITIVE = []
  include Aws::Structure
end

#app_security_group_management ⇒ `String`

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 5828

class CreateDomainRequest < Struct.new(
  :domain_name,
  :auth_mode,
  :default_user_settings,
  :domain_settings,
  :subnet_ids,
  :vpc_id,
  :tags,
  :app_network_access_type,
  :home_efs_file_system_kms_key_id,
  :kms_key_id,
  :app_security_group_management,
  :default_space_settings)
  SENSITIVE = []
  include Aws::Structure
end

#auth_mode ⇒ `String`

The mode of authentication that members use to access the domain.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 5828

class CreateDomainRequest < Struct.new(
  :domain_name,
  :auth_mode,
  :default_user_settings,
  :domain_settings,
  :subnet_ids,
  :vpc_id,
  :tags,
  :app_network_access_type,
  :home_efs_file_system_kms_key_id,
  :kms_key_id,
  :app_security_group_management,
  :default_space_settings)
  SENSITIVE = []
  include Aws::Structure
end

#default_space_settings ⇒ `Types::DefaultSpaceSettings`

The default settings used to create a space.

Returns:

(Types::DefaultSpaceSettings)

# File 'lib/aws-sdk-sagemaker/types.rb', line 5828

class CreateDomainRequest < Struct.new(
  :domain_name,
  :auth_mode,
  :default_user_settings,
  :domain_settings,
  :subnet_ids,
  :vpc_id,
  :tags,
  :app_network_access_type,
  :home_efs_file_system_kms_key_id,
  :kms_key_id,
  :app_security_group_management,
  :default_space_settings)
  SENSITIVE = []
  include Aws::Structure
end

#default_user_settings ⇒ `Types::UserSettings`

The default settings to use to create a user profile when UserSettings isn’t specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

Returns:

(Types::UserSettings)

# File 'lib/aws-sdk-sagemaker/types.rb', line 5828

class CreateDomainRequest < Struct.new(
  :domain_name,
  :auth_mode,
  :default_user_settings,
  :domain_settings,
  :subnet_ids,
  :vpc_id,
  :tags,
  :app_network_access_type,
  :home_efs_file_system_kms_key_id,
  :kms_key_id,
  :app_security_group_management,
  :default_space_settings)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ `String`

A name for the domain.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 5828

class CreateDomainRequest < Struct.new(
  :domain_name,
  :auth_mode,
  :default_user_settings,
  :domain_settings,
  :subnet_ids,
  :vpc_id,
  :tags,
  :app_network_access_type,
  :home_efs_file_system_kms_key_id,
  :kms_key_id,
  :app_security_group_management,
  :default_space_settings)
  SENSITIVE = []
  include Aws::Structure
end

#domain_settings ⇒ `Types::DomainSettings`

A collection of Domain settings.

Returns:

(Types::DomainSettings)

# File 'lib/aws-sdk-sagemaker/types.rb', line 5828

class CreateDomainRequest < Struct.new(
  :domain_name,
  :auth_mode,
  :default_user_settings,
  :domain_settings,
  :subnet_ids,
  :vpc_id,
  :tags,
  :app_network_access_type,
  :home_efs_file_system_kms_key_id,
  :kms_key_id,
  :app_security_group_management,
  :default_space_settings)
  SENSITIVE = []
  include Aws::Structure
end

#home_efs_file_system_kms_key_id ⇒ `String`

Use KmsKeyId.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 5828

class CreateDomainRequest < Struct.new(
  :domain_name,
  :auth_mode,
  :default_user_settings,
  :domain_settings,
  :subnet_ids,
  :vpc_id,
  :tags,
  :app_network_access_type,
  :home_efs_file_system_kms_key_id,
  :kms_key_id,
  :app_security_group_management,
  :default_space_settings)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 5828

class CreateDomainRequest < Struct.new(
  :domain_name,
  :auth_mode,
  :default_user_settings,
  :domain_settings,
  :subnet_ids,
  :vpc_id,
  :tags,
  :app_network_access_type,
  :home_efs_file_system_kms_key_id,
  :kms_key_id,
  :app_security_group_management,
  :default_space_settings)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ `Array<String>`

The VPC subnets that the domain uses for communication.

Returns:

(Array<String>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 5828

class CreateDomainRequest < Struct.new(
  :domain_name,
  :auth_mode,
  :default_user_settings,
  :domain_settings,
  :subnet_ids,
  :vpc_id,
  :tags,
  :app_network_access_type,
  :home_efs_file_system_kms_key_id,
  :kms_key_id,
  :app_security_group_management,
  :default_space_settings)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 5828

class CreateDomainRequest < Struct.new(
  :domain_name,
  :auth_mode,
  :default_user_settings,
  :domain_settings,
  :subnet_ids,
  :vpc_id,
  :tags,
  :app_network_access_type,
  :home_efs_file_system_kms_key_id,
  :kms_key_id,
  :app_security_group_management,
  :default_space_settings)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 5828

class CreateDomainRequest < Struct.new(
  :domain_name,
  :auth_mode,
  :default_user_settings,
  :domain_settings,
  :subnet_ids,
  :vpc_id,
  :tags,
  :app_network_access_type,
  :home_efs_file_system_kms_key_id,
  :kms_key_id,
  :app_security_group_management,
  :default_space_settings)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SageMaker::Types::CreateDomainRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#app_network_access_type ⇒ String

#app_security_group_management ⇒ String

#auth_mode ⇒ String

#default_space_settings ⇒ Types::DefaultSpaceSettings

#default_user_settings ⇒ Types::UserSettings

#domain_name ⇒ String

#domain_settings ⇒ Types::DomainSettings

#home_efs_file_system_kms_key_id ⇒ String

#kms_key_id ⇒ String

#subnet_ids ⇒ Array<String>

#tags ⇒ Array<Types::Tag>

#vpc_id ⇒ String

#app_network_access_type ⇒ `String`

#app_security_group_management ⇒ `String`

#auth_mode ⇒ `String`

#default_space_settings ⇒ `Types::DefaultSpaceSettings`

#default_user_settings ⇒ `Types::UserSettings`

#domain_name ⇒ `String`

#domain_settings ⇒ `Types::DomainSettings`

#home_efs_file_system_kms_key_id ⇒ `String`

#kms_key_id ⇒ `String`

#subnet_ids ⇒ `Array<String>`

#tags ⇒ `Array<Types::Tag>`

#vpc_id ⇒ `String`