Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderSaml

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cognito.UserPoolIdentityProviderSaml

All Implemented Interfaces:

IResource, IUserPoolIdentityProvider, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
           date="2023-10-26T00:56:05.954Z")
@Stability(Stable)
public class UserPoolIdentityProviderSaml
extends Resource
implements IUserPoolIdentityProvider

Represents a identity provider that integrates with SAML.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 ProviderAttribute providerAttribute;
 UserPool userPool;
 UserPoolIdentityProviderSamlMetadata userPoolIdentityProviderSamlMetadata;
 UserPoolIdentityProviderSaml userPoolIdentityProviderSaml = UserPoolIdentityProviderSaml.Builder.create(this, "MyUserPoolIdentityProviderSaml")
         .metadata(userPoolIdentityProviderSamlMetadata)
         .userPool(userPool)
         // the properties below are optional
         .attributeMapping(AttributeMapping.builder()
                 .address(providerAttribute)
                 .birthdate(providerAttribute)
                 .custom(Map.of(
                         "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)
                 .build())
         .identifiers(List.of("identifiers"))
         .idpSignout(false)
         .name("name")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UserPoolIdentityProviderSaml.Builder	A fluent builder for UserPoolIdentityProviderSaml.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.IUserPoolIdentityProvider

IUserPoolIdentityProvider.Jsii$Default, IUserPoolIdentityProvider.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserPoolIdentityProviderSaml(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserPoolIdentityProviderSaml(software.amazon.jsii.JsiiObjectRef objRef)
	UserPoolIdentityProviderSaml(software.constructs.Construct scope, String id, UserPoolIdentityProviderSamlProps props)

Method Summary

Modifier and Type	Method	Description
protected Object	configureAttributeMapping()
String	getProviderName()	The primary identifier of this identity provider.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

UserPoolIdentityProviderSaml

protected UserPoolIdentityProviderSaml(software.amazon.jsii.JsiiObjectRef objRef)

UserPoolIdentityProviderSaml

protected UserPoolIdentityProviderSaml(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

UserPoolIdentityProviderSaml

@Stability(Stable)
public UserPoolIdentityProviderSaml(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 UserPoolIdentityProviderSamlProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

configureAttributeMapping

@Stability(Stable)
@NotNull
protected Object configureAttributeMapping()

getProviderName

@Stability(Stable)
@NotNull
public String getProviderName()

The primary identifier of this identity provider.

Specified by:

getProviderName in interface IUserPoolIdentityProvider