Package software.amazon.awscdk.services.transfer

Interface CfnServer.IdentityProviderDetailsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnServer.IdentityProviderDetailsProperty.Jsii$Proxy
Enclosing class:
CfnServer
@Stability(Stable) public static interface CfnServer.IdentityProviderDetailsProperty extends software.amazon.jsii.JsiiSerializable
Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA or API_GATEWAY .

Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 IdentityProviderDetailsProperty identityProviderDetailsProperty = IdentityProviderDetailsProperty.builder()
         .directoryId("directoryId")
         .function("function")
         .invocationRole("invocationRole")
         .sftpAuthenticationMethods("sftpAuthenticationMethods")
         .url("url")
         .build();

  • Method Details

    • getDirectoryId

      @Stability(Stable) @Nullable default String getDirectoryId()
      The identifier of the AWS Directory Service directory that you want to stop sharing.

    • getFunction

      @Stability(Stable) @Nullable default String getFunction()
      The ARN for a Lambda function to use for the Identity provider.

    • getInvocationRole

      @Stability(Stable) @Nullable default String getInvocationRole()
      This parameter is only applicable if your IdentityProviderType is API_GATEWAY .

      Provides the type of InvocationRole used to authenticate the user account.

    • getSftpAuthenticationMethods

      @Stability(Stable) @Nullable default String getSftpAuthenticationMethods()
      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.

    • getUrl

      @Stability(Stable) @Nullable default String getUrl()
      Provides the location of the service endpoint used to authenticate users.

    • builder

      @Stability(Stable) static CfnServer.IdentityProviderDetailsProperty.Builder builder()
      Returns:
      a CfnServer.IdentityProviderDetailsProperty.Builder of CfnServer.IdentityProviderDetailsProperty