Class: Aws::SageMaker::Types::UpdateDomainRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::UpdateDomainRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #default_space_settings ⇒ Types::DefaultSpaceSettings

  The default settings for shared spaces that users create in the domain.

• #default_user_settings ⇒ Types::UserSettings

  A collection of settings.

• #domain_id ⇒ String

  The ID of the domain to be updated.

• #domain_settings_for_update ⇒ Types::DomainSettingsForUpdate

  A collection of DomainSettings configuration values to update.

• #subnet_ids ⇒ Array<String>

  The VPC subnets that Studio uses for communication.

• #tag_propagation ⇒ String

  Indicates whether custom tag propagation is supported for the domain.

Instance Attribute Details

#app_network_access_type ⇒ String

Specifies the VPC used for non-EFS traffic.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.

• VpcOnly - All Studio traffic is through the specified VPC and subnets.

This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

Returns:

• (String)

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

class UpdateDomainRequest < Struct.new(
  :domain_id,
  :default_user_settings,
  :domain_settings_for_update,
  :app_security_group_management,
  :default_space_settings,
  :subnet_ids,
  :app_network_access_type,
  :tag_propagation)
  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 47554

class UpdateDomainRequest < Struct.new(
  :domain_id,
  :default_user_settings,
  :domain_settings_for_update,
  :app_security_group_management,
  :default_space_settings,
  :subnet_ids,
  :app_network_access_type,
  :tag_propagation)
  SENSITIVE = []
  include Aws::Structure
end

#default_space_settings ⇒ Types::DefaultSpaceSettings

The default settings for shared spaces that users create in the domain.

Returns:

• (Types::DefaultSpaceSettings)

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

class UpdateDomainRequest < Struct.new(
  :domain_id,
  :default_user_settings,
  :domain_settings_for_update,
  :app_security_group_management,
  :default_space_settings,
  :subnet_ids,
  :app_network_access_type,
  :tag_propagation)
  SENSITIVE = []
  include Aws::Structure
end

#default_user_settings ⇒ Types::UserSettings

A collection of settings.

Returns:

• (Types::UserSettings)

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

class UpdateDomainRequest < Struct.new(
  :domain_id,
  :default_user_settings,
  :domain_settings_for_update,
  :app_security_group_management,
  :default_space_settings,
  :subnet_ids,
  :app_network_access_type,
  :tag_propagation)
  SENSITIVE = []
  include Aws::Structure
end

#domain_id ⇒ String

The ID of the domain to be updated.

Returns:

• (String)

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

class UpdateDomainRequest < Struct.new(
  :domain_id,
  :default_user_settings,
  :domain_settings_for_update,
  :app_security_group_management,
  :default_space_settings,
  :subnet_ids,
  :app_network_access_type,
  :tag_propagation)
  SENSITIVE = []
  include Aws::Structure
end

#domain_settings_for_update ⇒ Types::DomainSettingsForUpdate

A collection of DomainSettings configuration values to update.

Returns:

• (Types::DomainSettingsForUpdate)

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

class UpdateDomainRequest < Struct.new(
  :domain_id,
  :default_user_settings,
  :domain_settings_for_update,
  :app_security_group_management,
  :default_space_settings,
  :subnet_ids,
  :app_network_access_type,
  :tag_propagation)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

The VPC subnets that Studio uses for communication.

If removing subnets, ensure there are no apps in the InService, Pending, or Deleting state.

Returns:

• (Array<String>)

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

class UpdateDomainRequest < Struct.new(
  :domain_id,
  :default_user_settings,
  :domain_settings_for_update,
  :app_security_group_management,
  :default_space_settings,
  :subnet_ids,
  :app_network_access_type,
  :tag_propagation)
  SENSITIVE = []
  include Aws::Structure
end

#tag_propagation ⇒ String

Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

Returns:

• (String)

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

class UpdateDomainRequest < Struct.new(
  :domain_id,
  :default_user_settings,
  :domain_settings_for_update,
  :app_security_group_management,
  :default_space_settings,
  :subnet_ids,
  :app_network_access_type,
  :tag_propagation)
  SENSITIVE = []
  include Aws::Structure
end