class UserPoolIdentityProviderSamlMetadata

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.UserPoolIdentityProviderSamlMetadata
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolIdentityProviderSamlMetadata
Java	software.amazon.awscdk.services.cognito.UserPoolIdentityProviderSamlMetadata
Python	aws_cdk.aws_cognito.UserPoolIdentityProviderSamlMetadata
TypeScript (source)	aws-cdk-lib » aws_cognito » UserPoolIdentityProviderSamlMetadata

Metadata for a SAML user pool identity provider.

Example

const userpool = new cognito.UserPool(this, 'Pool');

// specify the metadata as a file content
new cognito.UserPoolIdentityProviderSaml(this, 'userpoolIdpFile', {
  userPool: userpool,
  metadata: cognito.UserPoolIdentityProviderSamlMetadata.file('my-file-contents'),
  // Whether to require encrypted SAML assertions from IdP
  encryptedResponses: true,
  // The signing algorithm for the SAML requests
  requestSigningAlgorithm: cognito.SigningAlgorithm.RSA_SHA256,
  // Enable IdP initiated SAML auth flow
  idpInitiated: true,
});

// specify the metadata as a URL
new cognito.UserPoolIdentityProviderSaml(this, 'userpoolidpUrl', {
  userPool: userpool,
  metadata: cognito.UserPoolIdentityProviderSamlMetadata.url('https://my-metadata-url.com'),
});

Properties

Name	Type	Description
metadataContent	string	A URL hosting SAML metadata, or the content of a file containing SAML metadata.
metadataType	UserPoolIdentityProviderSamlMetadataType	The type of metadata, either a URL or file content.

---

metadataContent

Type: string

A URL hosting SAML metadata, or the content of a file containing SAML metadata.

---

metadataType

Type: UserPoolIdentityProviderSamlMetadataType

The type of metadata, either a URL or file content.

Methods

Name	Description
static file(fileContent)	Specify SAML metadata via the contents of a file.
static url(url)	Specify SAML metadata via a URL.

---

static file(fileContent)

public static file(fileContent: string): UserPoolIdentityProviderSamlMetadata

Parameters

• fileContent string

Returns

• UserPoolIdentityProviderSamlMetadata

Specify SAML metadata via the contents of a file.

---

static url(url)

public static url(url: string): UserPoolIdentityProviderSamlMetadata

Parameters

• url string

Returns

• UserPoolIdentityProviderSamlMetadata

Specify SAML metadata via a URL.