Struct aws_sdk_transfer::model::listed_server::Builder
source · [−]#[non_exhaustive]pub struct Builder { /* private fields */ }
Expand description
A builder for ListedServer
Implementations
sourceimpl Builder
impl Builder
sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
sourcepub fn domain(self, input: Domain) -> Self
pub fn domain(self, input: Domain) -> Self
Specifies the domain of the storage system that is used for file transfers.
sourcepub fn set_domain(self, input: Option<Domain>) -> Self
pub fn set_domain(self, input: Option<Domain>) -> Self
Specifies the domain of the storage system that is used for file transfers.
sourcepub fn identity_provider_type(self, input: IdentityProviderType) -> Self
pub fn identity_provider_type(self, input: IdentityProviderType) -> Self
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The API_GATEWAY
setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in the Function
parameter for the IdentityProviderDetails
data type.
sourcepub fn set_identity_provider_type(
self,
input: Option<IdentityProviderType>
) -> Self
pub fn set_identity_provider_type(
self,
input: Option<IdentityProviderType>
) -> Self
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The API_GATEWAY
setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in the Function
parameter for the IdentityProviderDetails
data type.
sourcepub fn endpoint_type(self, input: EndpointType) -> Self
pub fn endpoint_type(self, input: EndpointType) -> Self
Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
sourcepub fn set_endpoint_type(self, input: Option<EndpointType>) -> Self
pub fn set_endpoint_type(self, input: Option<EndpointType>) -> Self
Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
sourcepub fn logging_role(self, input: impl Into<String>) -> Self
pub fn logging_role(self, input: impl Into<String>) -> Self
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
sourcepub fn set_logging_role(self, input: Option<String>) -> Self
pub fn set_logging_role(self, input: Option<String>) -> Self
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
sourcepub fn server_id(self, input: impl Into<String>) -> Self
pub fn server_id(self, input: impl Into<String>) -> Self
Specifies the unique system assigned identifier for the servers that were listed.
sourcepub fn set_server_id(self, input: Option<String>) -> Self
pub fn set_server_id(self, input: Option<String>) -> Self
Specifies the unique system assigned identifier for the servers that were listed.
sourcepub fn state(self, input: State) -> Self
pub fn state(self, input: State) -> Self
Specifies the condition of a server for the server that was described. A value of ONLINE
indicates that the server can accept jobs and transfer files. A State
value of OFFLINE
means that the server cannot perform file transfer operations.
The states of STARTING
and STOPPING
indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED
or STOP_FAILED
can indicate an error condition.
sourcepub fn set_state(self, input: Option<State>) -> Self
pub fn set_state(self, input: Option<State>) -> Self
Specifies the condition of a server for the server that was described. A value of ONLINE
indicates that the server can accept jobs and transfer files. A State
value of OFFLINE
means that the server cannot perform file transfer operations.
The states of STARTING
and STOPPING
indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED
or STOP_FAILED
can indicate an error condition.
sourcepub fn user_count(self, input: i32) -> Self
pub fn user_count(self, input: i32) -> Self
Specifies the number of users that are assigned to a server you specified with the ServerId
.
sourcepub fn set_user_count(self, input: Option<i32>) -> Self
pub fn set_user_count(self, input: Option<i32>) -> Self
Specifies the number of users that are assigned to a server you specified with the ServerId
.
sourcepub fn build(self) -> ListedServer
pub fn build(self) -> ListedServer
Consumes the builder and constructs a ListedServer
Trait Implementations
impl StructuralPartialEq for Builder
Auto Trait Implementations
impl RefUnwindSafe for Builder
impl Send for Builder
impl Sync for Builder
impl Unpin for Builder
impl UnwindSafe for Builder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more