Show / Hide Table of Contents

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html

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

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-applicationcallbackurl

AttributeMap

SAML attribute name and value.

object? AttributeMap { get; }
Property Value

object

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-attributemap

Type union: either IResolvable or (either IResolvable or CfnEnvironment.IAttributeMapItemsProperty)[]

FederationProviderName

Name of the identity provider (IdP).

string? FederationProviderName { get; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-federationprovidername

FederationUrn

The Uniform Resource Name (URN).

string? FederationUrn { get; }
Property Value

string

Remarks

Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-federationurn

SamlMetadataDocument

SAML 2.0 Metadata document from identity provider (IdP).

string? SamlMetadataDocument { get; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-samlmetadatadocument

SamlMetadataUrl

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

string? SamlMetadataUrl { get; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-samlmetadataurl

Back to top Generated by DocFX