Class UserPoolIdentityProviderSaml

Represents an identity provider that integrates with SAML.

Inheritance
object
Resource
UserPoolIdentityProviderSaml
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class UserPoolIdentityProviderSaml : Resource, IUserPoolIdentityProvider, IResource, IUserPoolIdentityProviderRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class UserPoolIdentityProviderSaml Inherits Resource Implements IUserPoolIdentityProvider, IResource, IUserPoolIdentityProviderRef, IConstruct, IDependable, IEnvironmentAware
Remarks

Resource: AWS::Cognito::UserPoolIdentityProvider

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

Constructors

UserPoolIdentityProviderSaml(Construct, string, IUserPoolIdentityProviderSamlProps)

Represents an identity provider that integrates with SAML.

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.
ProviderName

The primary identifier of this identity provider.
UserPoolIdentityProviderRef

A reference to a UserPoolIdentityProvider resource.

Methods

ConfigureAttributeMapping()

Represents an identity provider that integrates with SAML.

Constructors

UserPoolIdentityProviderSaml(Construct, string, IUserPoolIdentityProviderSamlProps)

Represents an identity provider that integrates with SAML.

public UserPoolIdentityProviderSaml(Construct scope, string id, IUserPoolIdentityProviderSamlProps props)
Parameters
scope Construct
id string
props IUserPoolIdentityProviderSamlProps
Remarks

Resource: AWS::Cognito::UserPoolIdentityProvider

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")
             });

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Resource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: infused

ProviderName

The primary identifier of this identity provider.

public virtual string ProviderName { get; }
Property Value

string

Remarks

Resource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: infused

UserPoolIdentityProviderRef

A reference to a UserPoolIdentityProvider resource.

public virtual IUserPoolIdentityProviderReference UserPoolIdentityProviderRef { get; }
Property Value

IUserPoolIdentityProviderReference

Remarks

Resource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: infused

Methods

ConfigureAttributeMapping()

Represents an identity provider that integrates with SAML.

protected virtual object ConfigureAttributeMapping()
Returns

object

Remarks

Resource: AWS::Cognito::UserPoolIdentityProvider

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")
             });

Implements

Constructs.IConstruct
Constructs.IDependable