aws_sdk_sagemaker/operation/update_domain/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_domain::_update_domain_output::UpdateDomainOutputBuilder;
3
4pub use crate::operation::update_domain::_update_domain_input::UpdateDomainInputBuilder;
5
6impl crate::operation::update_domain::builders::UpdateDomainInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::update_domain::UpdateDomainOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_domain::UpdateDomainError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_domain();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateDomain`.
24///
25/// <p>Updates the default settings for new user profiles in the domain.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct UpdateDomainFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::update_domain::builders::UpdateDomainInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::update_domain::UpdateDomainOutput,
35        crate::operation::update_domain::UpdateDomainError,
36    > for UpdateDomainFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::update_domain::UpdateDomainOutput,
44            crate::operation::update_domain::UpdateDomainError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl UpdateDomainFluentBuilder {
51    /// Creates a new `UpdateDomainFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the UpdateDomain as a reference.
60    pub fn as_input(&self) -> &crate::operation::update_domain::builders::UpdateDomainInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::update_domain::UpdateDomainOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::update_domain::UpdateDomainError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::update_domain::UpdateDomain::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::update_domain::UpdateDomain::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::update_domain::UpdateDomainOutput,
97        crate::operation::update_domain::UpdateDomainError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The ID of the domain to be updated.</p>
112    pub fn domain_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.domain_id(input.into());
114        self
115    }
116    /// <p>The ID of the domain to be updated.</p>
117    pub fn set_domain_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_domain_id(input);
119        self
120    }
121    /// <p>The ID of the domain to be updated.</p>
122    pub fn get_domain_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_domain_id()
124    }
125    /// <p>A collection of settings.</p>
126    pub fn default_user_settings(mut self, input: crate::types::UserSettings) -> Self {
127        self.inner = self.inner.default_user_settings(input);
128        self
129    }
130    /// <p>A collection of settings.</p>
131    pub fn set_default_user_settings(mut self, input: ::std::option::Option<crate::types::UserSettings>) -> Self {
132        self.inner = self.inner.set_default_user_settings(input);
133        self
134    }
135    /// <p>A collection of settings.</p>
136    pub fn get_default_user_settings(&self) -> &::std::option::Option<crate::types::UserSettings> {
137        self.inner.get_default_user_settings()
138    }
139    /// <p>A collection of <code>DomainSettings</code> configuration values to update.</p>
140    pub fn domain_settings_for_update(mut self, input: crate::types::DomainSettingsForUpdate) -> Self {
141        self.inner = self.inner.domain_settings_for_update(input);
142        self
143    }
144    /// <p>A collection of <code>DomainSettings</code> configuration values to update.</p>
145    pub fn set_domain_settings_for_update(mut self, input: ::std::option::Option<crate::types::DomainSettingsForUpdate>) -> Self {
146        self.inner = self.inner.set_domain_settings_for_update(input);
147        self
148    }
149    /// <p>A collection of <code>DomainSettings</code> configuration values to update.</p>
150    pub fn get_domain_settings_for_update(&self) -> &::std::option::Option<crate::types::DomainSettingsForUpdate> {
151        self.inner.get_domain_settings_for_update()
152    }
153    /// <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>
154    pub fn app_security_group_management(mut self, input: crate::types::AppSecurityGroupManagement) -> Self {
155        self.inner = self.inner.app_security_group_management(input);
156        self
157    }
158    /// <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>
159    pub fn set_app_security_group_management(mut self, input: ::std::option::Option<crate::types::AppSecurityGroupManagement>) -> Self {
160        self.inner = self.inner.set_app_security_group_management(input);
161        self
162    }
163    /// <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>
164    pub fn get_app_security_group_management(&self) -> &::std::option::Option<crate::types::AppSecurityGroupManagement> {
165        self.inner.get_app_security_group_management()
166    }
167    /// <p>The default settings for shared spaces that users create in the domain.</p>
168    pub fn default_space_settings(mut self, input: crate::types::DefaultSpaceSettings) -> Self {
169        self.inner = self.inner.default_space_settings(input);
170        self
171    }
172    /// <p>The default settings for shared spaces that users create in the domain.</p>
173    pub fn set_default_space_settings(mut self, input: ::std::option::Option<crate::types::DefaultSpaceSettings>) -> Self {
174        self.inner = self.inner.set_default_space_settings(input);
175        self
176    }
177    /// <p>The default settings for shared spaces that users create in the domain.</p>
178    pub fn get_default_space_settings(&self) -> &::std::option::Option<crate::types::DefaultSpaceSettings> {
179        self.inner.get_default_space_settings()
180    }
181    ///
182    /// Appends an item to `SubnetIds`.
183    ///
184    /// To override the contents of this collection use [`set_subnet_ids`](Self::set_subnet_ids).
185    ///
186    /// <p>The VPC subnets that Studio uses for communication.</p>
187    /// <p>If removing subnets, ensure there are no apps in the <code>InService</code>, <code>Pending</code>, or <code>Deleting</code> state.</p>
188    pub fn subnet_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
189        self.inner = self.inner.subnet_ids(input.into());
190        self
191    }
192    /// <p>The VPC subnets that Studio uses for communication.</p>
193    /// <p>If removing subnets, ensure there are no apps in the <code>InService</code>, <code>Pending</code>, or <code>Deleting</code> state.</p>
194    pub fn set_subnet_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
195        self.inner = self.inner.set_subnet_ids(input);
196        self
197    }
198    /// <p>The VPC subnets that Studio uses for communication.</p>
199    /// <p>If removing subnets, ensure there are no apps in the <code>InService</code>, <code>Pending</code>, or <code>Deleting</code> state.</p>
200    pub fn get_subnet_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
201        self.inner.get_subnet_ids()
202    }
203    /// <p>Specifies the VPC used for non-EFS traffic.</p>
204    /// <ul>
205    /// <li>
206    /// <p><code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.</p></li>
207    /// <li>
208    /// <p><code>VpcOnly</code> - All Studio traffic is through the specified VPC and subnets.</p></li>
209    /// </ul>
210    /// <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>
211    pub fn app_network_access_type(mut self, input: crate::types::AppNetworkAccessType) -> Self {
212        self.inner = self.inner.app_network_access_type(input);
213        self
214    }
215    /// <p>Specifies the VPC used for non-EFS traffic.</p>
216    /// <ul>
217    /// <li>
218    /// <p><code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.</p></li>
219    /// <li>
220    /// <p><code>VpcOnly</code> - All Studio traffic is through the specified VPC and subnets.</p></li>
221    /// </ul>
222    /// <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>
223    pub fn set_app_network_access_type(mut self, input: ::std::option::Option<crate::types::AppNetworkAccessType>) -> Self {
224        self.inner = self.inner.set_app_network_access_type(input);
225        self
226    }
227    /// <p>Specifies the VPC used for non-EFS traffic.</p>
228    /// <ul>
229    /// <li>
230    /// <p><code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.</p></li>
231    /// <li>
232    /// <p><code>VpcOnly</code> - All Studio traffic is through the specified VPC and subnets.</p></li>
233    /// </ul>
234    /// <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>
235    pub fn get_app_network_access_type(&self) -> &::std::option::Option<crate::types::AppNetworkAccessType> {
236        self.inner.get_app_network_access_type()
237    }
238    /// <p>Indicates whether custom tag propagation is supported for the domain. Defaults to <code>DISABLED</code>.</p>
239    pub fn tag_propagation(mut self, input: crate::types::TagPropagation) -> Self {
240        self.inner = self.inner.tag_propagation(input);
241        self
242    }
243    /// <p>Indicates whether custom tag propagation is supported for the domain. Defaults to <code>DISABLED</code>.</p>
244    pub fn set_tag_propagation(mut self, input: ::std::option::Option<crate::types::TagPropagation>) -> Self {
245        self.inner = self.inner.set_tag_propagation(input);
246        self
247    }
248    /// <p>Indicates whether custom tag propagation is supported for the domain. Defaults to <code>DISABLED</code>.</p>
249    pub fn get_tag_propagation(&self) -> &::std::option::Option<crate::types::TagPropagation> {
250        self.inner.get_tag_propagation()
251    }
252    /// <p>The identifier for the VPC used by the domain for network communication. Use this field only when adding VPC configuration to a SageMaker AI domain used in Amazon SageMaker Unified Studio that was created without VPC settings. SageMaker AI doesn't automatically apply VPC updates to existing applications. Stop and restart your applications to apply the changes.</p>
253    pub fn vpc_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
254        self.inner = self.inner.vpc_id(input.into());
255        self
256    }
257    /// <p>The identifier for the VPC used by the domain for network communication. Use this field only when adding VPC configuration to a SageMaker AI domain used in Amazon SageMaker Unified Studio that was created without VPC settings. SageMaker AI doesn't automatically apply VPC updates to existing applications. Stop and restart your applications to apply the changes.</p>
258    pub fn set_vpc_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
259        self.inner = self.inner.set_vpc_id(input);
260        self
261    }
262    /// <p>The identifier for the VPC used by the domain for network communication. Use this field only when adding VPC configuration to a SageMaker AI domain used in Amazon SageMaker Unified Studio that was created without VPC settings. SageMaker AI doesn't automatically apply VPC updates to existing applications. Stop and restart your applications to apply the changes.</p>
263    pub fn get_vpc_id(&self) -> &::std::option::Option<::std::string::String> {
264        self.inner.get_vpc_id()
265    }
266}