AWS Documentation » AWS CloudFormation » User Guide » AWS Transfer for SFTP Resource Type Reference » AWS::Transfer::Server » AWS::Transfer::Server IdentityProviderDetails

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Filter View: All JSON YAML

AWS::Transfer::Server IdentityProviderDetails

This parameter is required when the 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. This property is not required when the 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

The InvocationRole parameter provides the type of InvocationRole used to authenticate the user account.

Required: Yes

Type: String

Pattern: arn:.*role/.*

Update requires: No interruption

Url

The Url parameter provides contains the location of the service endpoint used to authenticate users.

Required: Yes

Type: String

Update requires: No interruption