Struct aws_sdk_transfer::model::described_server::Builder
source · [−]#[non_exhaustive]pub struct Builder { /* private fields */ }
Expand description
A builder for DescribedServer
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) of the server.
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) of the server.
sourcepub fn certificate(self, input: impl Into<String>) -> Self
pub fn certificate(self, input: impl Into<String>) -> Self
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols
is set to FTPS
.
sourcepub fn set_certificate(self, input: Option<String>) -> Self
pub fn set_certificate(self, input: Option<String>) -> Self
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols
is set to FTPS
.
sourcepub fn protocol_details(self, input: ProtocolDetails) -> Self
pub fn protocol_details(self, input: ProtocolDetails) -> Self
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.
sourcepub fn set_protocol_details(self, input: Option<ProtocolDetails>) -> Self
pub fn set_protocol_details(self, input: Option<ProtocolDetails>) -> Self
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.
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 endpoint_details(self, input: EndpointDetails) -> Self
pub fn endpoint_details(self, input: EndpointDetails) -> Self
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.
sourcepub fn set_endpoint_details(self, input: Option<EndpointDetails>) -> Self
pub fn set_endpoint_details(self, input: Option<EndpointDetails>) -> Self
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.
sourcepub fn endpoint_type(self, input: EndpointType) -> Self
pub fn endpoint_type(self, input: EndpointType) -> Self
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.
sourcepub fn set_endpoint_type(self, input: Option<EndpointType>) -> Self
pub fn set_endpoint_type(self, input: Option<EndpointType>) -> Self
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.
sourcepub fn host_key_fingerprint(self, input: impl Into<String>) -> Self
pub fn host_key_fingerprint(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_host_key_fingerprint(self, input: Option<String>) -> Self
pub fn set_host_key_fingerprint(self, input: Option<String>) -> Self
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.
sourcepub fn identity_provider_details(self, input: IdentityProviderDetails) -> Self
pub fn identity_provider_details(self, input: IdentityProviderDetails) -> Self
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
.
sourcepub fn set_identity_provider_details(
self,
input: Option<IdentityProviderDetails>
) -> Self
pub fn set_identity_provider_details(
self,
input: Option<IdentityProviderDetails>
) -> Self
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
.
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 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.
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.
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.
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.
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.
sourcepub fn protocols(self, input: Protocol) -> Self
pub fn protocols(self, input: Protocol) -> Self
Appends an item to protocols
.
To override the contents of this collection use set_protocols
.
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
sourcepub fn set_protocols(self, input: Option<Vec<Protocol>>) -> Self
pub fn set_protocols(self, input: Option<Vec<Protocol>>) -> Self
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
sourcepub fn security_policy_name(self, input: impl Into<String>) -> Self
pub fn security_policy_name(self, input: impl Into<String>) -> Self
Specifies the name of the security policy that is attached to the server.
sourcepub fn set_security_policy_name(self, input: Option<String>) -> Self
pub fn set_security_policy_name(self, input: Option<String>) -> Self
Specifies the name of the security policy that is attached to the server.
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 a server that you instantiate.
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 a server that you instantiate.
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.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
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 workflow_details(self, input: WorkflowDetails) -> Self
pub fn workflow_details(self, input: WorkflowDetails) -> Self
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
sourcepub fn set_workflow_details(self, input: Option<WorkflowDetails>) -> Self
pub fn set_workflow_details(self, input: Option<WorkflowDetails>) -> Self
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
sourcepub fn build(self) -> DescribedServer
pub fn build(self) -> DescribedServer
Consumes the builder and constructs a DescribedServer
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