Interface CfnEnvironment.IFederationParametersProperty
Configuration information when authentication mode is FEDERATED.
Namespace: Amazon.CDK.AWS.FinSpace
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnEnvironment.IFederationParametersProperty
Syntax (vb)
Public Interface CfnEnvironment.IFederationParametersProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.FinSpace;
var federationParametersProperty = new FederationParametersProperty {
ApplicationCallBackUrl = "applicationCallBackUrl",
AttributeMap = new [] { new AttributeMapItemsProperty {
Key = "key",
Value = "value"
} },
FederationProviderName = "federationProviderName",
FederationUrn = "federationUrn",
SamlMetadataDocument = "samlMetadataDocument",
SamlMetadataUrl = "samlMetadataUrl"
};
Synopsis
Properties
| ApplicationCallBackUrl | The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP). |
| AttributeMap | SAML attribute name and value. |
| FederationProviderName | Name of the identity provider (IdP). |
| FederationUrn | The Uniform Resource Name (URN). |
| SamlMetadataDocument | SAML 2.0 Metadata document from identity provider (IdP). |
| SamlMetadataUrl | Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP). |
Properties
ApplicationCallBackUrl
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
string? ApplicationCallBackUrl { get; }
Property Value
Remarks
AttributeMap
SAML attribute name and value.
object? AttributeMap { get; }
Property Value
Remarks
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.
Type union: either IResolvable or (either IResolvable or CfnEnvironment.IAttributeMapItemsProperty)[]
FederationProviderName
Name of the identity provider (IdP).
string? FederationProviderName { get; }
Property Value
Remarks
FederationUrn
The Uniform Resource Name (URN).
string? FederationUrn { get; }
Property Value
Remarks
Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
SamlMetadataDocument
SAML 2.0 Metadata document from identity provider (IdP).
string? SamlMetadataDocument { get; }
Property Value
Remarks
SamlMetadataUrl
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
string? SamlMetadataUrl { get; }