pub struct JoinDomainFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to JoinDomain.
Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
Joining a domain creates an Active Directory computer account in the default organizational unit, using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). If your Active Directory environment requires that you pre-stage accounts to facilitate the join domain process, you will need to create this account ahead of time.
To create the gateway's computer account in an organizational unit other than the default, you must specify the organizational unit when joining the domain.
Implementations§
Source§impl JoinDomainFluentBuilder
impl JoinDomainFluentBuilder
Sourcepub fn as_input(&self) -> &JoinDomainInputBuilder
pub fn as_input(&self) -> &JoinDomainInputBuilder
Access the JoinDomain as a reference.
Sourcepub async fn send(
self,
) -> Result<JoinDomainOutput, SdkError<JoinDomainError, HttpResponse>>
pub async fn send( self, ) -> Result<JoinDomainOutput, SdkError<JoinDomainError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<JoinDomainOutput, JoinDomainError, Self>
pub fn customize( self, ) -> CustomizableOperation<JoinDomainOutput, JoinDomainError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn gateway_arn(self, input: impl Into<String>) -> Self
pub fn gateway_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Sourcepub fn set_gateway_arn(self, input: Option<String>) -> Self
pub fn set_gateway_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Sourcepub fn get_gateway_arn(&self) -> &Option<String>
pub fn get_gateway_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Sourcepub fn domain_name(self, input: impl Into<String>) -> Self
pub fn domain_name(self, input: impl Into<String>) -> Self
The name of the domain that you want the gateway to join.
Sourcepub fn set_domain_name(self, input: Option<String>) -> Self
pub fn set_domain_name(self, input: Option<String>) -> Self
The name of the domain that you want the gateway to join.
Sourcepub fn get_domain_name(&self) -> &Option<String>
pub fn get_domain_name(&self) -> &Option<String>
The name of the domain that you want the gateway to join.
Sourcepub fn organizational_unit(self, input: impl Into<String>) -> Self
pub fn organizational_unit(self, input: impl Into<String>) -> Self
The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
Sourcepub fn set_organizational_unit(self, input: Option<String>) -> Self
pub fn set_organizational_unit(self, input: Option<String>) -> Self
The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
Sourcepub fn get_organizational_unit(&self) -> &Option<String>
pub fn get_organizational_unit(&self) -> &Option<String>
The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
Sourcepub fn domain_controllers(self, input: impl Into<String>) -> Self
pub fn domain_controllers(self, input: impl Into<String>) -> Self
Appends an item to DomainControllers.
To override the contents of this collection use set_domain_controllers.
List of IP addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
S3 File Gateway supports IPv6 addresses in addition to IPv4 and other existing formats.
FSx File Gateway does not support IPv6.
Sourcepub fn set_domain_controllers(self, input: Option<Vec<String>>) -> Self
pub fn set_domain_controllers(self, input: Option<Vec<String>>) -> Self
List of IP addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
S3 File Gateway supports IPv6 addresses in addition to IPv4 and other existing formats.
FSx File Gateway does not support IPv6.
Sourcepub fn get_domain_controllers(&self) -> &Option<Vec<String>>
pub fn get_domain_controllers(&self) -> &Option<Vec<String>>
List of IP addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
S3 File Gateway supports IPv6 addresses in addition to IPv4 and other existing formats.
FSx File Gateway does not support IPv6.
Sourcepub fn timeout_in_seconds(self, input: i32) -> Self
pub fn timeout_in_seconds(self, input: i32) -> Self
Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.
Sourcepub fn set_timeout_in_seconds(self, input: Option<i32>) -> Self
pub fn set_timeout_in_seconds(self, input: Option<i32>) -> Self
Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.
Sourcepub fn get_timeout_in_seconds(&self) -> &Option<i32>
pub fn get_timeout_in_seconds(&self) -> &Option<i32>
Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.
Sourcepub fn user_name(self, input: impl Into<String>) -> Self
pub fn user_name(self, input: impl Into<String>) -> Self
Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.
Sourcepub fn set_user_name(self, input: Option<String>) -> Self
pub fn set_user_name(self, input: Option<String>) -> Self
Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.
Sourcepub fn get_user_name(&self) -> &Option<String>
pub fn get_user_name(&self) -> &Option<String>
Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.
Sourcepub fn password(self, input: impl Into<String>) -> Self
pub fn password(self, input: impl Into<String>) -> Self
Sets the password of the user who has permission to add the gateway to the Active Directory domain.
Sourcepub fn set_password(self, input: Option<String>) -> Self
pub fn set_password(self, input: Option<String>) -> Self
Sets the password of the user who has permission to add the gateway to the Active Directory domain.
Sourcepub fn get_password(&self) -> &Option<String>
pub fn get_password(&self) -> &Option<String>
Sets the password of the user who has permission to add the gateway to the Active Directory domain.
Trait Implementations§
Source§impl Clone for JoinDomainFluentBuilder
impl Clone for JoinDomainFluentBuilder
Source§fn clone(&self) -> JoinDomainFluentBuilder
fn clone(&self) -> JoinDomainFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for JoinDomainFluentBuilder
impl !RefUnwindSafe for JoinDomainFluentBuilder
impl Send for JoinDomainFluentBuilder
impl Sync for JoinDomainFluentBuilder
impl Unpin for JoinDomainFluentBuilder
impl !UnwindSafe for JoinDomainFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);