interface FederationParametersProperty

Language	Type name
.NET	`Amazon.CDK.AWS.FinSpace.CfnEnvironment.FederationParametersProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsfinspace#CfnEnvironment_FederationParametersProperty`
Java	`software.amazon.awscdk.services.finspace.CfnEnvironment.FederationParametersProperty`
Python	`aws_cdk.aws_finspace.CfnEnvironment.FederationParametersProperty`
TypeScript	`aws-cdk-lib` » `aws_finspace` » `CfnEnvironment` » `FederationParametersProperty`

Configuration information when authentication mode is FEDERATED.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_finspace as finspace } from 'aws-cdk-lib';
const federationParametersProperty: finspace.CfnEnvironment.FederationParametersProperty = {
  applicationCallBackUrl: 'applicationCallBackUrl',
  attributeMap: [{
    key: 'key',
    value: 'value',
  }],
  federationProviderName: 'federationProviderName',
  federationUrn: 'federationUrn',
  samlMetadataDocument: 'samlMetadataDocument',
  samlMetadataUrl: 'samlMetadataUrl',
};

Properties

Name	Type	Description
applicationCallBackUrl?	`string`	The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
attributeMap?	`IResolvable` `\|` `IResolvable` `\|` `AttributeMapItemsProperty[]`	SAML attribute name and value.
federationProviderName?	`string`	Name of the identity provider (IdP).
federationUrn?	`string`	The Uniform Resource Name (URN).
samlMetadataDocument?	`string`	SAML 2.0 Metadata document from identity provider (IdP).
samlMetadataUrl?	`string`	Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

applicationCallBackUrl?

Type: string (optional)

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

attributeMap?

Type: IResolvable | IResolvable | AttributeMapItemsProperty[] (optional)

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.

federationProviderName?

Type: string (optional)

Name of the identity provider (IdP).

federationUrn?

Type: string (optional)

The Uniform Resource Name (URN).

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

samlMetadataDocument?

Type: string (optional)

SAML 2.0 Metadata document from identity provider (IdP).

samlMetadataUrl?

Type: string (optional)

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