Class UserPoolIdentityProviderSamlMetadata
Metadata for a SAML user pool identity provider.
Inheritance
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class UserPoolIdentityProviderSamlMetadata : DeputyBase
Syntax (vb)
Public Class UserPoolIdentityProviderSamlMetadata
Inherits DeputyBase
Remarks
ExampleMetadata: infused
Examples
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")
});
Synopsis
Constructors
UserPoolIdentityProviderSamlMetadata(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
UserPoolIdentityProviderSamlMetadata(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
MetadataContent | A URL hosting SAML metadata, or the content of a file containing SAML metadata. |
MetadataType | The type of metadata, either a URL or file content. |
Methods
File(String) | Specify SAML metadata via the contents of a file. |
Url(String) | Specify SAML metadata via a URL. |
Constructors
UserPoolIdentityProviderSamlMetadata(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected UserPoolIdentityProviderSamlMetadata(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
UserPoolIdentityProviderSamlMetadata(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected UserPoolIdentityProviderSamlMetadata(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
MetadataContent
A URL hosting SAML metadata, or the content of a file containing SAML metadata.
public virtual string MetadataContent { get; }
Property Value
System.String
MetadataType
The type of metadata, either a URL or file content.
public virtual UserPoolIdentityProviderSamlMetadataType MetadataType { get; }
Property Value
UserPoolIdentityProviderSamlMetadataType
Methods
File(String)
Specify SAML metadata via the contents of a file.
public static UserPoolIdentityProviderSamlMetadata File(string fileContent)
Parameters
- fileContent System.String
Returns
UserPoolIdentityProviderSamlMetadata
Url(String)
Specify SAML metadata via a URL.
public static UserPoolIdentityProviderSamlMetadata Url(string url)
Parameters
- url System.String
Returns
UserPoolIdentityProviderSamlMetadata