AWS::Transfer::Server IdentityProviderDetails

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "DirectoryId" : String,
  "Function" : String,
  "InvocationRole" : String,
  "Url" : String
}

YAML

  DirectoryId: String
  Function: String
  InvocationRole: String
  Url: String

Properties

DirectoryId

The identifier of the AWS Directory Service directory that you want to stop sharing.

Required: No

Type: String

Minimum: 12

Maximum: 12

Pattern: ^d-[0-9a-f]{10}$

Update requires: No interruption

Function

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

Required: No

Type: String

Minimum: 1

Maximum: 170

Pattern: ^arn:[a-z-]+:lambda:.*$

Update requires: No interruption

InvocationRole

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

Required: No

Type: String

Minimum: 20

Maximum: 2048

Pattern: arn:.*role/.*

Update requires: No interruption

Url

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

Required: No

Type: String

Maximum: 255

Update requires: No interruption

See also

IdentityProviderDetails in the AWS Transfer Family User Guide.