Struct aws_sdk_transfer::types::IdentityProviderDetails

#[non_exhaustive]
pub struct IdentityProviderDetails {
    pub url: Option<String>,
    pub invocation_role: Option<String>,
    pub directory_id: Option<String>,
    pub function: Option<String>,
    pub sftp_authentication_methods: Option<SftpAuthenticationMethods>,
}

Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.

Fields (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.

url: Option<String>

Provides the location of the service endpoint used to authenticate users.

invocation_role: Option<String>

This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user account.

directory_id: Option<String>

The identifier of the Directory Service directory that you want to use as your identity provider.

function: Option<String>

The ARN for a Lambda function to use for the Identity provider.

sftp_authentication_methods: Option<SftpAuthenticationMethods>

For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.

• PASSWORD - users must provide their password to connect.

• PUBLIC_KEY - users must provide their private key to connect.

• PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.

• PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.

Implementations

impl IdentityProviderDetails

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

Provides the location of the service endpoint used to authenticate users.

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

This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user account.

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

The identifier of the Directory Service directory that you want to use as your identity provider.

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

The ARN for a Lambda function to use for the Identity provider.

pub fn sftp_authentication_methods(&self) -> Option<&SftpAuthenticationMethods>

For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.

• PASSWORD - users must provide their password to connect.

• PUBLIC_KEY - users must provide their private key to connect.

• PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.

• PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.

impl IdentityProviderDetails

pub fn builder() -> IdentityProviderDetailsBuilder

Creates a new builder-style object to manufacture IdentityProviderDetails.

Trait Implementations

impl Clone for IdentityProviderDetails

fn clone(&self) -> IdentityProviderDetails

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityProviderDetails

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

Formats the value using the given formatter.

impl PartialEq for IdentityProviderDetails

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IdentityProviderDetails