Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderSamlMetadata

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.UserPoolIdentityProviderSamlMetadata

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-09-06T01:36:25.620Z")
@Stability(Stable)
public class UserPoolIdentityProviderSamlMetadata
extends software.amazon.jsii.JsiiObject

Metadata for a SAML user pool identity provider.

Example:

 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();
 

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserPoolIdentityProviderSamlMetadata(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserPoolIdentityProviderSamlMetadata(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static UserPoolIdentityProviderSamlMetadata	file(String fileContent)	Specify SAML metadata via the contents of a file.
String	getMetadataContent()	A URL hosting SAML metadata, or the content of a file containing SAML metadata.
UserPoolIdentityProviderSamlMetadataType	getMetadataType()	The type of metadata, either a URL or file content.
static UserPoolIdentityProviderSamlMetadata	url(String url)	Specify SAML metadata via a URL.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

UserPoolIdentityProviderSamlMetadata

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

UserPoolIdentityProviderSamlMetadata

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

Method Details

file

@Stability(Stable)
@NotNull
public static UserPoolIdentityProviderSamlMetadata file(@NotNull
 String fileContent)

Specify SAML metadata via the contents of a file.

Parameters:

fileContent - This parameter is required.

url

@Stability(Stable)
@NotNull
public static UserPoolIdentityProviderSamlMetadata url(@NotNull
 String url)

Specify SAML metadata via a URL.

Parameters:

url - This parameter is required.

getMetadataContent

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

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

getMetadataType

@Stability(Stable)
@NotNull
public UserPoolIdentityProviderSamlMetadataType getMetadataType()

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