[−][src]Struct rusoto_transfer::CreateServerRequest
Fields
certificate: Option<String>
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols
is set to FTPS
.
To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
-
2048-bit RSA (RSA2048)
-
4096-bit RSA (RSA4096)
-
Elliptic Prime Curve 256 bit (ECprime256v1)
-
Elliptic Prime Curve 384 bit (ECsecp384r1)
-
Elliptic Prime Curve 521 bit (EC_secp521r1)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
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 IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
endpoint_type: Option<String>
The type of VPC endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
It is recommended that you use VPC
as the EndpointType
. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType
set to VPC_ENDPOINT
.
host_key: Option<String>
The RSA private key as generated by the ssh-keygen -N "" -m PEM -f my-new-server-key
command.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.
identity_provider_details: Option<IdentityProviderDetails>
Required when IdentityProviderType
is set to API_GATEWAY
. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType
is set to SERVICE_MANAGED
.
identity_provider_type: Option<String>
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 AWS Transfer Family service. 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.
logging_role: Option<String>
Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
protocols: Option<Vec<String>>
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
If you select FTPS
, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.
If Protocol
includes either FTP
or FTPS
, then the EndpointType
must be VPC
and the IdentityProviderType
must be APIGATEWAY
.
If Protocol
includes FTP
, then AddressAllocationIds
cannot be associated.
If Protocol
is set only to SFTP
, the EndpointType
can be set to PUBLIC
and the IdentityProviderType
can be set to SERVICEMANAGED
.
security_policy_name: Option<String>
Specifies the name of the security policy that is attached to the server.
Key-value pairs that can be used to group and search for servers.
Trait Implementations
impl Clone for CreateServerRequest
[src]
pub fn clone(&self) -> CreateServerRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for CreateServerRequest
[src]
impl Default for CreateServerRequest
[src]
pub fn default() -> CreateServerRequest
[src]
impl PartialEq<CreateServerRequest> for CreateServerRequest
[src]
pub fn eq(&self, other: &CreateServerRequest) -> bool
[src]
pub fn ne(&self, other: &CreateServerRequest) -> bool
[src]
impl Serialize for CreateServerRequest
[src]
pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralPartialEq for CreateServerRequest
[src]
Auto Trait Implementations
impl RefUnwindSafe for CreateServerRequest
[src]
impl Send for CreateServerRequest
[src]
impl Sync for CreateServerRequest
[src]
impl Unpin for CreateServerRequest
[src]
impl UnwindSafe for CreateServerRequest
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,