AWS::Transfer::Server IdentityProviderDetails - AWS CloudFormation

AWS::Transfer::Server IdentityProviderDetails

Required when IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call 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

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

YAML

InvocationRole: String Url: String

Properties

InvocationRole

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

Required: Yes

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: Yes

Type: String

Maximum: 255

Update requires: No interruption

See also

IdentityProviderDetails in the AWS Transfer Family User Guide.