aws_sdk_sagemaker/client/
update_domain.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateDomain`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain_id(impl Into<String>)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::set_domain_id):<br>required: **true**<br><p>The ID of the domain to be updated.</p><br>
7    ///   - [`default_user_settings(UserSettings)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::default_user_settings) / [`set_default_user_settings(Option<UserSettings>)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::set_default_user_settings):<br>required: **false**<br><p>A collection of settings.</p><br>
8    ///   - [`domain_settings_for_update(DomainSettingsForUpdate)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::domain_settings_for_update) / [`set_domain_settings_for_update(Option<DomainSettingsForUpdate>)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::set_domain_settings_for_update):<br>required: **false**<br><p>A collection of <code>DomainSettings</code> configuration values to update.</p><br>
9    ///   - [`app_security_group_management(AppSecurityGroupManagement)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::app_security_group_management) / [`set_app_security_group_management(Option<AppSecurityGroupManagement>)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::set_app_security_group_management):<br>required: **false**<br><p>The entity that creates and manages the required security groups for inter-app communication in <code>VPCOnly</code> mode. Required when <code>CreateDomain.AppNetworkAccessType</code> is <code>VPCOnly</code> and <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is provided. If setting up the domain for use with RStudio, this value must be set to <code>Service</code>.</p><br>
10    ///   - [`default_space_settings(DefaultSpaceSettings)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::default_space_settings) / [`set_default_space_settings(Option<DefaultSpaceSettings>)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::set_default_space_settings):<br>required: **false**<br><p>The default settings for shared spaces that users create in the domain.</p><br>
11    ///   - [`subnet_ids(impl Into<String>)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::subnet_ids) / [`set_subnet_ids(Option<Vec::<String>>)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::set_subnet_ids):<br>required: **false**<br><p>The VPC subnets that Studio uses for communication.</p> <p>If removing subnets, ensure there are no apps in the <code>InService</code>, <code>Pending</code>, or <code>Deleting</code> state.</p><br>
12    ///   - [`app_network_access_type(AppNetworkAccessType)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::app_network_access_type) / [`set_app_network_access_type(Option<AppNetworkAccessType>)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::set_app_network_access_type):<br>required: **false**<br><p>Specifies the VPC used for non-EFS traffic.</p> <ul>  <li>   <p><code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.</p></li>  <li>   <p><code>VpcOnly</code> - All Studio traffic is through the specified VPC and subnets.</p></li> </ul> <p>This configuration can only be modified if there are no apps in the <code>InService</code>, <code>Pending</code>, or <code>Deleting</code> state. The configuration cannot be updated if <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is already set or <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is provided as part of the same request.</p><br>
13    ///   - [`tag_propagation(TagPropagation)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::tag_propagation) / [`set_tag_propagation(Option<TagPropagation>)`](crate::operation::update_domain::builders::UpdateDomainFluentBuilder::set_tag_propagation):<br>required: **false**<br><p>Indicates whether custom tag propagation is supported for the domain. Defaults to <code>DISABLED</code>.</p><br>
14    /// - On success, responds with [`UpdateDomainOutput`](crate::operation::update_domain::UpdateDomainOutput) with field(s):
15    ///   - [`domain_arn(Option<String>)`](crate::operation::update_domain::UpdateDomainOutput::domain_arn): <p>The Amazon Resource Name (ARN) of the domain.</p>
16    /// - On failure, responds with [`SdkError<UpdateDomainError>`](crate::operation::update_domain::UpdateDomainError)
17    pub fn update_domain(&self) -> crate::operation::update_domain::builders::UpdateDomainFluentBuilder {
18        crate::operation::update_domain::builders::UpdateDomainFluentBuilder::new(self.handle.clone())
19    }
20}