Struct aws_sdk_sagemaker::operation::create_domain::CreateDomainInput

#[non_exhaustive]
pub struct CreateDomainInput {
    pub domain_name: Option<String>,
    pub auth_mode: Option<AuthMode>,
    pub default_user_settings: Option<UserSettings>,
    pub domain_settings: Option<DomainSettings>,
    pub subnet_ids: Option<Vec<String>>,
    pub vpc_id: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub app_network_access_type: Option<AppNetworkAccessType>,
    pub home_efs_file_system_kms_key_id: Option<String>,
    pub kms_key_id: Option<String>,
    pub app_security_group_management: Option<AppSecurityGroupManagement>,
    pub default_space_settings: Option<DefaultSpaceSettings>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

domain_name: Option<String>

A name for the domain.

auth_mode: Option<AuthMode>

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

default_user_settings: Option<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.

domain_settings: Option<DomainSettings>

A collection of Domain settings.

subnet_ids: Option<Vec<String>>

The VPC subnets that the domain uses for communication.

vpc_id: Option<String>

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

tags: Option<Vec<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.

app_network_access_type: Option<AppNetworkAccessType>

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

home_efs_file_system_kms_key_id: Option<String>

👎Deprecated: This property is deprecated, use KmsKeyId instead.

Use KmsKeyId.

kms_key_id: Option<String>

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

app_security_group_management: Option<AppSecurityGroupManagement>

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.

default_space_settings: Option<DefaultSpaceSettings>

The default settings used to create a space.

Implementations

impl CreateDomainInput

pub fn domain_name(&self) -> Option<&str>

A name for the domain.

pub fn auth_mode(&self) -> Option<&AuthMode>

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

pub fn default_user_settings(&self) -> Option<&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.

pub fn domain_settings(&self) -> Option<&DomainSettings>

A collection of Domain settings.

pub fn subnet_ids(&self) -> &[String]

The VPC subnets that the domain uses for communication.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .subnet_ids.is_none().

pub fn vpc_id(&self) -> Option<&str>

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

pub fn tags(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn app_network_access_type(&self) -> Option<&AppNetworkAccessType>

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

pub fn home_efs_file_system_kms_key_id(&self) -> Option<&str>

👎Deprecated: This property is deprecated, use KmsKeyId instead.

Use KmsKeyId.

pub fn kms_key_id(&self) -> Option<&str>

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

pub fn app_security_group_management( &self, ) -> Option<&AppSecurityGroupManagement>

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.

pub fn default_space_settings(&self) -> Option<&DefaultSpaceSettings>

The default settings used to create a space.

impl CreateDomainInput

pub fn builder() -> CreateDomainInputBuilder

Creates a new builder-style object to manufacture CreateDomainInput.

Trait Implementations

impl Clone for CreateDomainInput

fn clone(&self) -> CreateDomainInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateDomainInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateDomainInput

fn eq(&self, other: &CreateDomainInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateDomainInput