AWS::FinSpace::Environment FederationParameters
Configuration information when authentication mode is FEDERATED.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "ApplicationCallBackURL" :
String
, "AttributeMap" :Json
, "FederationProviderName" :String
, "FederationURN" :String
, "SamlMetadataDocument" :String
, "SamlMetadataURL" :String
}
YAML
ApplicationCallBackURL:
String
AttributeMap:Json
FederationProviderName:String
FederationURN:String
SamlMetadataDocument:String
SamlMetadataURL:String
Properties
ApplicationCallBackURL
-
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
Required: No
Type: String
Minimum:
1
Maximum:
1000
Pattern:
^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]
Update requires: No interruption
AttributeMap
-
SAML attribute name and value. The name must always be
Email
and the value should be set to the attribute definition in which user email is set. For example, name would beEmail
and valuehttp://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.Required: No
Type: Json
Update requires: No interruption
FederationProviderName
-
Name of the identity provider (IdP).
Required: No
Type: String
Minimum:
1
Maximum:
32
Pattern:
[^_\p{Z}][\p{L}\p{M}\p{S}\p{N}\p{P}][^_\p{Z}]+
Update requires: No interruption
FederationURN
-
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
Required: No
Type: String
Minimum:
1
Maximum:
255
Pattern:
^[A-Za-z0-9._\-:\/#\+]+$
Update requires: No interruption
SamlMetadataDocument
-
SAML 2.0 Metadata document from identity provider (IdP).
Required: No
Type: String
Minimum:
1000
Maximum:
10000000
Pattern:
.*
Update requires: No interruption
SamlMetadataURL
-
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
Required: No
Type: String
Minimum:
1
Maximum:
1000
Pattern:
^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]
Update requires: No interruption