UserPoolIdentityProviderSaml L2 construct

Represents an identity provider that integrates with SAML.

CloudFormation: AWS::Cognito::UserPoolIdentityProvider
L1 type: CfnUserPoolIdentityProvider
Source: aws-cognito/lib/user-pool-idps/saml.ts
Type last changed: v2.235.0 · 15 Jan 2026

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'),
});

python

userpool = cognito.UserPool(self, "Pool")

# specify the metadata as a file content
cognito.UserPoolIdentityProviderSaml(self, "userpoolIdpFile",
    user_pool=userpool,
    metadata=cognito.UserPoolIdentityProviderSamlMetadata.file("my-file-contents"),
    # Whether to require encrypted SAML assertions from IdP
    encrypted_responses=True,
    # The signing algorithm for the SAML requests
    request_signing_algorithm=cognito.SigningAlgorithm.RSA_SHA256,
    # Enable IdP initiated SAML auth flow
    idp_initiated=True
)

# specify the metadata as a URL
cognito.UserPoolIdentityProviderSaml(self, "userpoolidpUrl",
    user_pool=userpool,
    metadata=cognito.UserPoolIdentityProviderSamlMetadata.url("https://my-metadata-url.com")
)

java

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

// specify the metadata as a file content
// specify the metadata as a file content
UserPoolIdentityProviderSaml.Builder.create(this, "userpoolIdpFile")
        .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)
        .build();

// specify the metadata as a URL
// specify the metadata as a URL
UserPoolIdentityProviderSaml.Builder.create(this, "userpoolidpUrl")
        .userPool(userpool)
        .metadata(UserPoolIdentityProviderSamlMetadata.url("https://my-metadata-url.com"))
        .build();

csharp

// Install: dotnet add package Amazon.CDK.Lib
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")
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
userpool := cognito.NewUserPool(this, jsii.String("Pool"))

// specify the metadata as a file content
// specify the metadata as a file content
cognito.NewUserPoolIdentityProviderSaml(this, jsii.String("userpoolIdpFile"), &UserPoolIdentityProviderSamlProps{
	UserPool: userpool,
	Metadata: cognito.UserPoolIdentityProviderSamlMetadata_File(jsii.String("my-file-contents")),
	// Whether to require encrypted SAML assertions from IdP
	EncryptedResponses: jsii.Boolean(true),
	// The signing algorithm for the SAML requests
	RequestSigningAlgorithm: cognito.SigningAlgorithm_RSA_SHA256,
	// Enable IdP initiated SAML auth flow
	IdpInitiated: jsii.Boolean(true),
})

// specify the metadata as a URL
// specify the metadata as a URL
cognito.NewUserPoolIdentityProviderSaml(this, jsii.String("userpoolidpUrl"), &UserPoolIdentityProviderSamlProps{
	UserPool: userpool,
	Metadata: cognito.UserPoolIdentityProviderSamlMetadata_Url(jsii.String("https://my-metadata-url.com")),
})

Initializer

new UserPoolIdentityProviderSaml(scope: Construct, id: string, props: UserPoolIdentityProviderSamlProps)

python

UserPoolIdentityProviderSaml(scope: Construct, id: str, props: UserPoolIdentityProviderSamlProps)

java

new UserPoolIdentityProviderSaml(Construct scope, String id, UserPoolIdentityProviderSamlProps props)

csharp

new UserPoolIdentityProviderSaml(Construct scope, string id, UserPoolIdentityProviderSamlProps props)

NewUserPoolIdentityProviderSaml(Scope Construct, Id *string, Props UserPoolIdentityProviderSamlProps)

Construct Props

attributeMappingAttributeMappingattribute_mappingAttributeMappingattributeMappingAttributeMappingAttributeMappingAttributeMappingAttributeMappingAttributeMapping#

Mapping attributes from the identity provider to standard and custom attributes of the user pool.

Default: no attribute mapping

encryptedResponsesbooleanencrypted_responsesboolencryptedResponsesBooleanEncryptedResponsesboolEncryptedResponses*bool= false#

Whether to require encrypted SAML assertions from IdP.

identifiersstring[]identifierstyping.List[str]identifiersList<String>Identifiersstring[]Identifiers*[]*string#

Identifiers.

Default: no identifiers used

Identifiers can be used to redirect users to the correct IdP in multitenant apps.

idpInitiatedbooleanidp_initiatedboolidpInitiatedBooleanIdpInitiatedboolIdpInitiated*bool= false#

Whether to enable IdP-initiated SAML auth flows.

idpSignoutbooleanidp_signoutboolidpSignoutBooleanIdpSignoutboolIdpSignout*bool= false#

Whether to enable the "Sign-out flow" feature.

metadataUserPoolIdentityProviderSamlMetadatametadataUserPoolIdentityProviderSamlMetadatametadataUserPoolIdentityProviderSamlMetadataMetadataUserPoolIdentityProviderSamlMetadataMetadataUserPoolIdentityProviderSamlMetadatarequired#

The SAML metadata.

namestringnamestrnameStringNamestringName*string#

The name of the provider.

Default: the unique ID of the construct

Must be between 3 and 32 characters.

requestSigningAlgorithmSigningAlgorithmrequest_signing_algorithmSigningAlgorithmrequestSigningAlgorithmSigningAlgorithmRequestSigningAlgorithmSigningAlgorithmRequestSigningAlgorithmSigningAlgorithm#

The signing algorithm for SAML requests.

Default: don't sign requests

userPoolIUserPooluser_poolIUserPooluserPoolIUserPoolUserPoolIUserPoolUserPoolIUserPoolrequired#

The user pool to which this construct provides identities.

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#

Uniquely identifies this class.

providerNamestringprovider_namestrproviderNameStringProviderNamestringProviderName*stringrequired#

The primary identifier of this identity provider.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

userPoolIdentityProviderRefUserPoolIdentityProviderReferenceuser_pool_identity_provider_refUserPoolIdentityProviderReferenceuserPoolIdentityProviderRefUserPoolIdentityProviderReferenceUserPoolIdentityProviderRefUserPoolIdentityProviderReferenceUserPoolIdentityProviderRefUserPoolIdentityProviderReferencerequired#

A reference to a UserPoolIdentityProvider resource.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

UserPoolIdentityProviderSaml L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​