#[non_exhaustive]pub struct CreateLocationSmbInput {Show 13 fields
pub subdirectory: Option<String>,
pub server_hostname: Option<String>,
pub user: Option<String>,
pub domain: Option<String>,
pub password: Option<String>,
pub agent_arns: Option<Vec<String>>,
pub mount_options: Option<SmbMountOptions>,
pub tags: Option<Vec<TagListEntry>>,
pub authentication_type: Option<SmbAuthenticationType>,
pub dns_ip_addresses: Option<Vec<String>>,
pub kerberos_principal: Option<String>,
pub kerberos_keytab: Option<Blob>,
pub kerberos_krb5_conf: Option<Blob>,
}
Expand description
CreateLocationSmbRequest
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.subdirectory: Option<String>
Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/subdirectory
). Make sure that other SMB clients in your network can also mount this path.
To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers.
server_hostname: Option<String>
Specifies the domain name or IP address of the SMB file server that your DataSync agent connects to.
Remember the following when configuring this parameter:
-
You can't specify an IP version 6 (IPv6) address.
-
If you're using Kerberos authentication, you must specify a domain name.
user: Option<String>
Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter applies only if AuthenticationType
is set to NTLM
.
For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.
domain: Option<String>
Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if AuthenticationType
is set to NTLM
.
If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
password: Option<String>
Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType
is set to NTLM
.
agent_arns: Option<Vec<String>>
Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
mount_options: Option<SmbMountOptions>
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
authentication_type: Option<SmbAuthenticationType>
Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM
(default) and KERBEROS
authentication.
For more information, see Providing DataSync access to SMB file servers.
dns_ip_addresses: Option<Vec<String>>
Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType
is set to KERBEROS
.
If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
kerberos_principal: Option<String>
Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.
A Kerberos principal might look like HOST/kerberosuser@MYDOMAIN.ORG
.
Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.
kerberos_keytab: Option<Blob>
Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal
.
kerberos_krb5_conf: Option<Blob>
Specifies a Kerberos configuration file (krb5.conf
) that defines your Kerberos realm configuration.
The file must be base64 encoded. If you're using the CLI, the encoding is done for you.
Implementations§
Source§impl CreateLocationSmbInput
impl CreateLocationSmbInput
Sourcepub fn subdirectory(&self) -> Option<&str>
pub fn subdirectory(&self) -> Option<&str>
Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/subdirectory
). Make sure that other SMB clients in your network can also mount this path.
To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers.
Sourcepub fn server_hostname(&self) -> Option<&str>
pub fn server_hostname(&self) -> Option<&str>
Specifies the domain name or IP address of the SMB file server that your DataSync agent connects to.
Remember the following when configuring this parameter:
-
You can't specify an IP version 6 (IPv6) address.
-
If you're using Kerberos authentication, you must specify a domain name.
Sourcepub fn user(&self) -> Option<&str>
pub fn user(&self) -> Option<&str>
Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter applies only if AuthenticationType
is set to NTLM
.
For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.
Sourcepub fn domain(&self) -> Option<&str>
pub fn domain(&self) -> Option<&str>
Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if AuthenticationType
is set to NTLM
.
If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
Sourcepub fn password(&self) -> Option<&str>
pub fn password(&self) -> Option<&str>
Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType
is set to NTLM
.
Sourcepub fn agent_arns(&self) -> &[String]
pub fn agent_arns(&self) -> &[String]
Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .agent_arns.is_none()
.
Sourcepub fn mount_options(&self) -> Option<&SmbMountOptions>
pub fn mount_options(&self) -> Option<&SmbMountOptions>
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
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()
.
Sourcepub fn authentication_type(&self) -> Option<&SmbAuthenticationType>
pub fn authentication_type(&self) -> Option<&SmbAuthenticationType>
Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM
(default) and KERBEROS
authentication.
For more information, see Providing DataSync access to SMB file servers.
Sourcepub fn dns_ip_addresses(&self) -> &[String]
pub fn dns_ip_addresses(&self) -> &[String]
Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType
is set to KERBEROS
.
If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .dns_ip_addresses.is_none()
.
Sourcepub fn kerberos_principal(&self) -> Option<&str>
pub fn kerberos_principal(&self) -> Option<&str>
Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.
A Kerberos principal might look like HOST/kerberosuser@MYDOMAIN.ORG
.
Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.
Sourcepub fn kerberos_keytab(&self) -> Option<&Blob>
pub fn kerberos_keytab(&self) -> Option<&Blob>
Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal
.
Sourcepub fn kerberos_krb5_conf(&self) -> Option<&Blob>
pub fn kerberos_krb5_conf(&self) -> Option<&Blob>
Specifies a Kerberos configuration file (krb5.conf
) that defines your Kerberos realm configuration.
The file must be base64 encoded. If you're using the CLI, the encoding is done for you.
Source§impl CreateLocationSmbInput
impl CreateLocationSmbInput
Sourcepub fn builder() -> CreateLocationSmbInputBuilder
pub fn builder() -> CreateLocationSmbInputBuilder
Creates a new builder-style object to manufacture CreateLocationSmbInput
.
Trait Implementations§
Source§impl Clone for CreateLocationSmbInput
impl Clone for CreateLocationSmbInput
Source§fn clone(&self) -> CreateLocationSmbInput
fn clone(&self) -> CreateLocationSmbInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateLocationSmbInput
impl Debug for CreateLocationSmbInput
Source§impl PartialEq for CreateLocationSmbInput
impl PartialEq for CreateLocationSmbInput
impl StructuralPartialEq for CreateLocationSmbInput
Auto Trait Implementations§
impl Freeze for CreateLocationSmbInput
impl RefUnwindSafe for CreateLocationSmbInput
impl Send for CreateLocationSmbInput
impl Sync for CreateLocationSmbInput
impl Unpin for CreateLocationSmbInput
impl UnwindSafe for CreateLocationSmbInput
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);