Struct aws_sdk_transfer::model::DescribedServer

source · [−]

#[non_exhaustive]
pub struct DescribedServer {Show 19 fields
    pub arn: Option<String>,
    pub certificate: Option<String>,
    pub protocol_details: Option<ProtocolDetails>,
    pub domain: Option<Domain>,
    pub endpoint_details: Option<EndpointDetails>,
    pub endpoint_type: Option<EndpointType>,
    pub host_key_fingerprint: Option<String>,
    pub identity_provider_details: Option<IdentityProviderDetails>,
    pub identity_provider_type: Option<IdentityProviderType>,
    pub logging_role: Option<String>,
    pub post_authentication_login_banner: Option<String>,
    pub pre_authentication_login_banner: Option<String>,
    pub protocols: Option<Vec<Protocol>>,
    pub security_policy_name: Option<String>,
    pub server_id: Option<String>,
    pub state: Option<State>,
    pub tags: Option<Vec<Tag>>,
    pub user_count: Option<i32>,
    pub workflow_details: Option<WorkflowDetails>,
}

Expand description

Describes the 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) of the server.

certificate: Option<String>

Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

protocol_details: Option<ProtocolDetails>

The protocol settings that are configured for your server.

Use the PassiveIp parameter to indicate passive mode. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

domain: Option<Domain>

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

endpoint_details: Option<EndpointDetails>

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

endpoint_type: Option<EndpointType>

Defines the type of 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.

host_key_fingerprint: Option<String>

Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

identity_provider_details: Option<IdentityProviderDetails>

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.

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.

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.

post_authentication_login_banner: Option<String>

Specify a string to display when users connect to a server. This string is displayed after the user authenticates.

The SFTP protocol does not support post-authentication display banners.

pre_authentication_login_banner: Option<String>

Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

protocols: Option<Vec<Protocol>>

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
FTP (File Transfer Protocol): Unencrypted file transfer

security_policy_name: Option<String>

Specifies the name of the security policy that is attached to the server.

server_id: Option<String>

Specifies the unique system-assigned identifier for a server that you instantiate.

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.

tags: Option<Vec<Tag>>

Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

user_count: Option<i32>

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

workflow_details: Option<WorkflowDetails>

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Struct aws_sdk_transfer::model::DescribedServer

Fields (Non-exhaustive)

Implementations

impl DescribedServer

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

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

pub fn protocol_details(&self) -> Option<&ProtocolDetails>

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

pub fn endpoint_details(&self) -> Option<&EndpointDetails>

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

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

pub fn identity_provider_details(&self) -> Option<&IdentityProviderDetails>

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

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

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

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

pub fn protocols(&self) -> Option<&[Protocol]>

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

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

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

pub fn tags(&self) -> Option<&[Tag]>

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

pub fn workflow_details(&self) -> Option<&WorkflowDetails>

impl DescribedServer

pub fn builder() -> Builder

Trait Implementations

impl Clone for DescribedServer

fn clone(&self) -> DescribedServer

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

impl Debug for DescribedServer

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

impl PartialEq<DescribedServer> for DescribedServer

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

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

impl StructuralPartialEq for DescribedServer

Auto Trait Implementations

impl RefUnwindSafe for DescribedServer

impl Send for DescribedServer

impl Sync for DescribedServer

impl Unpin for DescribedServer

impl UnwindSafe for DescribedServer

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>

pub fn protocols(&self) -> Option<&[Protocol ]>

pub fn tags(&self) -> Option<&[Tag ]>

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>,