Class UserPoolIdentityProviderSamlMetadata

Metadata for a SAML user pool identity provider.

Inheritance

object

UserPoolIdentityProviderSamlMetadata

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class UserPoolIdentityProviderSamlMetadata : DeputyBase

Syntax (vb)

Public Class UserPoolIdentityProviderSamlMetadata Inherits DeputyBase

Remarks

ExampleMetadata: infused

Examples

var userpool = new UserPool(this, "Pool");

            // specify the metadata as a file content
            // specify the metadata as a file content
            new UserPoolIdentityProviderSaml(this, "userpoolIdpFile", new UserPoolIdentityProviderSamlProps {
                UserPool = userpool,
                Metadata = UserPoolIdentityProviderSamlMetadata.File("my-file-contents"),
                // Whether to require encrypted SAML assertions from IdP
                EncryptedResponses = true,
                // The signing algorithm for the SAML requests
                RequestSigningAlgorithm = SigningAlgorithm.RSA_SHA256,
                // Enable IdP initiated SAML auth flow
                IdpInitiated = true
            });

            // specify the metadata as a URL
            // specify the metadata as a URL
            new UserPoolIdentityProviderSaml(this, "userpoolidpUrl", new UserPoolIdentityProviderSamlProps {
                UserPool = userpool,
                Metadata = UserPoolIdentityProviderSamlMetadata.Url("https://my-metadata-url.com")
            });

Synopsis

Properties

MetadataContent	A URL hosting SAML metadata, or the content of a file containing SAML metadata.
MetadataType	The type of metadata, either a URL or file content.

Methods

File(string)	Specify SAML metadata via the contents of a file.
Url(string)	Specify SAML metadata via a URL.

Properties

MetadataContent

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

public virtual string MetadataContent { get; }

Property Value

string

Remarks

ExampleMetadata: infused

MetadataType

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

public virtual UserPoolIdentityProviderSamlMetadataType MetadataType { get; }

Property Value

UserPoolIdentityProviderSamlMetadataType

Remarks

ExampleMetadata: infused

Methods

File(string)

Specify SAML metadata via the contents of a file.

public static UserPoolIdentityProviderSamlMetadata File(string fileContent)

Parameters

fileContent string

Returns

UserPoolIdentityProviderSamlMetadata

Remarks

ExampleMetadata: infused

Url(string)

Specify SAML metadata via a URL.

public static UserPoolIdentityProviderSamlMetadata Url(string url)

Parameters

url string

Returns

UserPoolIdentityProviderSamlMetadata

Remarks

ExampleMetadata: infused