aws_sdk_transfer/operation/describe_access/_describe_access_input.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeAccessInput {
/// <p>A system-assigned unique identifier for a server that has this access assigned.</p>
pub server_id: ::std::option::Option<::std::string::String>,
/// <p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p>
/// <p><code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code></p>
/// <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
/// <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>
pub external_id: ::std::option::Option<::std::string::String>,
}
impl DescribeAccessInput {
/// <p>A system-assigned unique identifier for a server that has this access assigned.</p>
pub fn server_id(&self) -> ::std::option::Option<&str> {
self.server_id.as_deref()
}
/// <p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p>
/// <p><code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code></p>
/// <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
/// <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>
pub fn external_id(&self) -> ::std::option::Option<&str> {
self.external_id.as_deref()
}
}
impl DescribeAccessInput {
/// Creates a new builder-style object to manufacture [`DescribeAccessInput`](crate::operation::describe_access::DescribeAccessInput).
pub fn builder() -> crate::operation::describe_access::builders::DescribeAccessInputBuilder {
crate::operation::describe_access::builders::DescribeAccessInputBuilder::default()
}
}
/// A builder for [`DescribeAccessInput`](crate::operation::describe_access::DescribeAccessInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeAccessInputBuilder {
pub(crate) server_id: ::std::option::Option<::std::string::String>,
pub(crate) external_id: ::std::option::Option<::std::string::String>,
}
impl DescribeAccessInputBuilder {
/// <p>A system-assigned unique identifier for a server that has this access assigned.</p>
/// This field is required.
pub fn server_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.server_id = ::std::option::Option::Some(input.into());
self
}
/// <p>A system-assigned unique identifier for a server that has this access assigned.</p>
pub fn set_server_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.server_id = input;
self
}
/// <p>A system-assigned unique identifier for a server that has this access assigned.</p>
pub fn get_server_id(&self) -> &::std::option::Option<::std::string::String> {
&self.server_id
}
/// <p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p>
/// <p><code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code></p>
/// <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
/// <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>
/// This field is required.
pub fn external_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.external_id = ::std::option::Option::Some(input.into());
self
}
/// <p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p>
/// <p><code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code></p>
/// <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
/// <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>
pub fn set_external_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.external_id = input;
self
}
/// <p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p>
/// <p><code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code></p>
/// <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
/// <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>
pub fn get_external_id(&self) -> &::std::option::Option<::std::string::String> {
&self.external_id
}
/// Consumes the builder and constructs a [`DescribeAccessInput`](crate::operation::describe_access::DescribeAccessInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::describe_access::DescribeAccessInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::describe_access::DescribeAccessInput {
server_id: self.server_id,
external_id: self.external_id,
})
}
}