interface IdentityProviderDetailsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Transfer.CfnServer.IdentityProviderDetailsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awstransfer#CfnServer_IdentityProviderDetailsProperty`
Java	`software.amazon.awscdk.services.transfer.CfnServer.IdentityProviderDetailsProperty`
Python	`aws_cdk.aws_transfer.CfnServer.IdentityProviderDetailsProperty`
TypeScript	`aws-cdk-lib` » `aws_transfer` » `CfnServer` » `IdentityProviderDetailsProperty`

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. Cannot be specified 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 { aws_transfer as transfer } from 'aws-cdk-lib';
const identityProviderDetailsProperty: transfer.CfnServer.IdentityProviderDetailsProperty = {
  directoryId: 'directoryId',
  function: 'function',
  invocationRole: 'invocationRole',
  sftpAuthenticationMethods: 'sftpAuthenticationMethods',
  url: 'url',
};

Properties

Name	Type	Description
directoryId?	`string`	The identifier of the AWS Directory Service directory that you want to use as your identity provider.
function?	`string`	The ARN for a Lambda function to use for the Identity provider.
invocationRole?	`string`	This parameter is only applicable if your `IdentityProviderType` is `API_GATEWAY` .
sftpAuthenticationMethods?	`string`	For SFTP-enabled servers, and for custom identity providers only , you can specify whether to authenticate using a password, SSH key pair, or both.
url?	`string`	Provides the location of the service endpoint used to authenticate users.

directoryId?

Type: string (optional)

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

function?

Type: string (optional)

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

invocationRole?

Type: string (optional)

This parameter is only applicable if your IdentityProviderType is API_GATEWAY .

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

sftpAuthenticationMethods?

Type: string (optional)

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.

url?

Type: string (optional)

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