Struct aws_sdk_transfer::types::builders::IdentityProviderDetailsBuilder

#[non_exhaustive]
pub struct IdentityProviderDetailsBuilder { /* private fields */ }

A builder for IdentityProviderDetails.

Implementations

impl IdentityProviderDetailsBuilder

pub fn url(self, input: impl Into<String>) -> Self

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

pub fn set_url(self, input: Option<String>) -> Self

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

pub fn get_url(&self) -> &Option<String>

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

pub fn invocation_role(self, input: impl Into<String>) -> Self

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

pub fn set_invocation_role(self, input: Option<String>) -> Self

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

pub fn get_invocation_role(&self) -> &Option<String>

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, input: impl Into<String>) -> Self

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

pub fn set_directory_id(self, input: Option<String>) -> Self

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

pub fn get_directory_id(&self) -> &Option<String>

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

pub fn function(self, input: impl Into<String>) -> Self

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

pub fn set_function(self, input: Option<String>) -> Self

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

pub fn get_function(&self) -> &Option<String>

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

pub fn sftp_authentication_methods( self, input: SftpAuthenticationMethods, ) -> Self

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.

pub fn set_sftp_authentication_methods( self, input: Option<SftpAuthenticationMethods>, ) -> Self

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.

pub fn get_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.

pub fn build(self) -> IdentityProviderDetails

Consumes the builder and constructs a IdentityProviderDetails.

Trait Implementations

impl Clone for IdentityProviderDetailsBuilder

fn clone(&self) -> IdentityProviderDetailsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityProviderDetailsBuilder

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

Formats the value using the given formatter.

impl Default for IdentityProviderDetailsBuilder

fn default() -> IdentityProviderDetailsBuilder

Returns the “default value” for a type.

impl PartialEq for IdentityProviderDetailsBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for IdentityProviderDetailsBuilder