AWS::FinSpace::Environment FederationParameters

Configuration information when authentication mode is FEDERATED.

Syntax

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

JSON

{
  "ApplicationCallBackURL" : String,
  "AttributeMap" : [ AttributeMapItems, ... ],
  "FederationProviderName" : String,
  "FederationURN" : String,
  "SamlMetadataDocument" : String,
  "SamlMetadataURL" : String
}

YAML

  ApplicationCallBackURL: String
  AttributeMap: 
    - AttributeMapItems
  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

Pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}

Update requires: Replacement

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 be Email and value http://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: Array of AttributeMapItems

Update requires: Replacement

FederationProviderName

Name of the identity provider (IdP).

Required: No

Type: String

Pattern: [^_\p{Z}][\p{L}\p{M}\p{S}\p{N}\p{P}][^_\p{Z}]+

Minimum: 1

Maximum: 32

Update requires: Replacement

FederationURN

The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

Required: No

Type: String

Pattern: ^[A-Za-z0-9._\-:\/#\+]+$

Minimum: 1

Maximum: 255

Update requires: Replacement

SamlMetadataDocument

SAML 2.0 Metadata document from identity provider (IdP).

Required: No

Type: String

Pattern: .*

Minimum: 1000

Maximum: 10000000

Update requires: Replacement

SamlMetadataURL

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

Required: No

Type: String

Pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}

Update requires: Replacement