Struct aws_sdk_transfer::model::ListedServer

source · [−]

#[non_exhaustive]pub struct ListedServer {
    pub arn: Option<String>,
    pub domain: Option<Domain>,
    pub identity_provider_type: Option<IdentityProviderType>,
    pub endpoint_type: Option<EndpointType>,
    pub logging_role: Option<String>,
    pub server_id: Option<String>,
    pub state: Option<State>,
    pub user_count: Option<i32>,
}

Expand description

Returns properties of a file transfer protocol-enabled server that was specified.

Fields (Non-exhaustive)

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

arn: Option<String>

Specifies the unique Amazon Resource Name (ARN) for a server to be listed.

domain: Option<Domain>

Specifies the domain of the storage system that is used for file transfers.

identity_provider_type: Option<IdentityProviderType>

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.

endpoint_type: Option<EndpointType>

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.

logging_role: Option<String>

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.

server_id: Option<String>

Specifies the unique system assigned identifier for the servers that were listed.

state: Option<State>

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.

user_count: Option<i32>

Specifies the number of users that are assigned to a server you specified with the ServerId.

Struct aws_sdk_transfer::model::ListedServer

Fields (Non-exhaustive)

Implementations

impl ListedServer

pub fn arn(&self) -> Option<&str>

pub fn domain(&self) -> Option<&Domain>

pub fn identity_provider_type(&self) -> Option<&IdentityProviderType>

pub fn endpoint_type(&self) -> Option<&EndpointType>

pub fn logging_role(&self) -> Option<&str>

pub fn server_id(&self) -> Option<&str>

pub fn state(&self) -> Option<&State>

pub fn user_count(&self) -> Option<i32>

impl ListedServer

pub fn builder() -> Builder

Trait Implementations

impl Clone for ListedServer

fn clone(&self) -> ListedServer

fn clone_from(&mut self, source: &Self)

impl Debug for ListedServer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl PartialEq<ListedServer> for ListedServer

fn eq(&self, other: &ListedServer) -> bool

fn ne(&self, other: &ListedServer) -> bool

impl StructuralPartialEq for ListedServer

Auto Trait Implementations

impl RefUnwindSafe for ListedServer

impl Send for ListedServer

impl Sync for ListedServer

impl Unpin for ListedServer

impl UnwindSafe for ListedServer

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,