UserPoolIdentityProviderSamlMetadata

class aws_cdk.aws_cognito.UserPoolIdentityProviderSamlMetadata(*args: Any, **kwargs)

Bases: object

Metadata for a SAML user pool identity provider.

ExampleMetadata:: infused

Example:

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

Attributes

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

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

Static Methods

classmethod file(file_content)

Specify SAML metadata via the contents of a file.

Parameters:: file_content (str)
Return type:: UserPoolIdentityProviderSamlMetadata

classmethod url(url)

Specify SAML metadata via a URL.

Parameters:: url (str)
Return type:: UserPoolIdentityProviderSamlMetadata