Table of Contents

Class SamlProviderProps

Namespace
Amazon.CDK.AWS.IAM
Assembly
Amazon.CDK.AWS.IAM.dll

Properties for a SAML provider.

public class SamlProviderProps : ISamlProviderProps
Inheritance
SamlProviderProps
Implements
Inherited Members

Examples

var provider = new SamlProvider(this, "Provider", new SamlProviderProps {
                MetadataDocument = SamlMetadataDocument.FromFile("/path/to/saml-metadata-document.xml")
            });
            new Role(this, "Role", new RoleProps {
                AssumedBy = new SamlConsolePrincipal(provider)
            });

Remarks

ExampleMetadata: infused

Constructors

SamlProviderProps() 

public SamlProviderProps()

Properties

MetadataDocument

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

public SamlMetadataDocument MetadataDocument { get; set; }

Property Value

SamlMetadataDocument

Name

The name of the provider to create.

public string? Name { get; set; }

Property Value

string

Remarks

This parameter allows a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Length must be between 1 and 128 characters.

Default: - a CloudFormation generated name