Class CfnEnvironmentPropsMixin.FederationParametersProperty

Configuration information when authentication mode is FEDERATED.

Inheritance

object

CfnEnvironmentPropsMixin.FederationParametersProperty

Implements

CfnEnvironmentPropsMixin.IFederationParametersProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.FinSpace.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnEnvironmentPropsMixin.FederationParametersProperty : CfnEnvironmentPropsMixin.IFederationParametersProperty

Syntax (vb)

Public Class CfnEnvironmentPropsMixin.FederationParametersProperty Implements CfnEnvironmentPropsMixin.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.Mixins.Preview.AWS.FinSpace.Mixins;

             var federationParametersProperty = new FederationParametersProperty {
                 ApplicationCallBackUrl = "applicationCallBackUrl",
                 AttributeMap = new [] { new AttributeMapItemsProperty {
                     Key = "key",
                     Value = "value"
                 } },
                 FederationProviderName = "federationProviderName",
                 FederationUrn = "federationUrn",
                 SamlMetadataDocument = "samlMetadataDocument",
                 SamlMetadataUrl = "samlMetadataUrl"
             };

Synopsis

Constructors

FederationParametersProperty()

Configuration information when authentication mode is FEDERATED.

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).

Constructors

FederationParametersProperty()

Configuration information when authentication mode is FEDERATED.

public FederationParametersProperty()

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.Mixins.Preview.AWS.FinSpace.Mixins;

             var federationParametersProperty = new FederationParametersProperty {
                 ApplicationCallBackUrl = "applicationCallBackUrl",
                 AttributeMap = new [] { new AttributeMapItemsProperty {
                     Key = "key",
                     Value = "value"
                 } },
                 FederationProviderName = "federationProviderName",
                 FederationUrn = "federationUrn",
                 SamlMetadataDocument = "samlMetadataDocument",
                 SamlMetadataUrl = "samlMetadataUrl"
             };

Properties

ApplicationCallBackUrl

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

public string? ApplicationCallBackUrl { get; set; }

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.

public object? AttributeMap { get; set; }

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 CfnEnvironmentPropsMixin.IAttributeMapItemsProperty)[]

FederationProviderName

Name of the identity provider (IdP).

public string? FederationProviderName { get; set; }

Property Value

string

Remarks

FederationUrn

The Uniform Resource Name (URN).

public string? FederationUrn { get; set; }

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).

public string? SamlMetadataDocument { get; set; }

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).

public string? SamlMetadataUrl { get; set; }