Class UserPoolIdentityProviderSaml
Represents an identity provider that integrates with SAML.
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class UserPoolIdentityProviderSaml : Resource, IUserPoolIdentityProvider, IResource
Syntax (vb)
Public Class UserPoolIdentityProviderSaml
Inherits Resource
Implements IUserPoolIdentityProvider, IResource
Remarks
Resource: AWS::Cognito::UserPoolIdentityProvider
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.AWS.Cognito;
ProviderAttribute providerAttribute;
UserPool userPool;
UserPoolIdentityProviderSamlMetadata userPoolIdentityProviderSamlMetadata;
var userPoolIdentityProviderSaml = new UserPoolIdentityProviderSaml(this, "MyUserPoolIdentityProviderSaml", new UserPoolIdentityProviderSamlProps {
Metadata = userPoolIdentityProviderSamlMetadata,
UserPool = userPool,
// the properties below are optional
AttributeMapping = new AttributeMapping {
Address = providerAttribute,
Birthdate = providerAttribute,
Custom = new Dictionary<string, ProviderAttribute> {
{ "customKey", providerAttribute }
},
Email = providerAttribute,
FamilyName = providerAttribute,
Fullname = providerAttribute,
Gender = providerAttribute,
GivenName = providerAttribute,
LastUpdateTime = providerAttribute,
Locale = providerAttribute,
MiddleName = providerAttribute,
Nickname = providerAttribute,
PhoneNumber = providerAttribute,
PreferredUsername = providerAttribute,
ProfilePage = providerAttribute,
ProfilePicture = providerAttribute,
Timezone = providerAttribute,
Website = providerAttribute
},
Identifiers = new [] { "identifiers" },
IdpSignout = false,
Name = "name"
});
Synopsis
Constructors
UserPoolIdentityProviderSaml(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
UserPoolIdentityProviderSaml(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
UserPoolIdentityProviderSaml(Construct, String, IUserPoolIdentityProviderSamlProps) |
Properties
ProviderName | The primary identifier of this identity provider. |
Methods
ConfigureAttributeMapping() |
Constructors
UserPoolIdentityProviderSaml(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected UserPoolIdentityProviderSaml(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
UserPoolIdentityProviderSaml(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected UserPoolIdentityProviderSaml(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
UserPoolIdentityProviderSaml(Construct, String, IUserPoolIdentityProviderSamlProps)
public UserPoolIdentityProviderSaml(Construct scope, string id, IUserPoolIdentityProviderSamlProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IUserPoolIdentityProviderSamlProps
Properties
ProviderName
The primary identifier of this identity provider.
public virtual string ProviderName { get; }
Property Value
System.String
Methods
ConfigureAttributeMapping()
protected virtual object ConfigureAttributeMapping()
Returns
System.Object
Implements
Constructs.IConstruct
Constructs.IDependable