Interface CfnServer.IIdentityProviderDetailsProperty

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA or API_GATEWAY .

Namespace: Amazon.CDK.AWS.Transfer

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnServer.IIdentityProviderDetailsProperty

Syntax (vb)

Public Interface CfnServer.IIdentityProviderDetailsProperty

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Transfer;

             var identityProviderDetailsProperty = new IdentityProviderDetailsProperty {
                 DirectoryId = "directoryId",
                 Function = "function",
                 InvocationRole = "invocationRole",
                 SftpAuthenticationMethods = "sftpAuthenticationMethods",
                 Url = "url"
             };

Synopsis

Properties

DirectoryId	The identifier of the AWS Directory Service directory that you want to use as your identity provider.
Function	The ARN for a Lambda function to use for the Identity provider.
InvocationRole	This parameter is only applicable if your IdentityProviderType is API_GATEWAY .
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.
Url	Provides the location of the service endpoint used to authenticate users.

Properties

DirectoryId

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

string? DirectoryId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-directoryid

Function

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

string? Function { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-function

InvocationRole

This parameter is only applicable if your IdentityProviderType is API_GATEWAY .

string? InvocationRole { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-invocationrole

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.

string? SftpAuthenticationMethods { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-sftpauthenticationmethods

Url

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

string? Url { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-url