Class SamlProviderProps

Properties for a SAML provider.

Inheritance

object

SamlProviderProps

Implements

ISamlProviderProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.IAM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class SamlProviderProps : ISamlProviderProps

Syntax (vb)

Public Class SamlProviderProps Implements ISamlProviderProps

Remarks

ExampleMetadata: infused

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

Synopsis

Constructors

SamlProviderProps()

Properties for a SAML provider.

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.
Name	The name of the provider to create.

Constructors

SamlProviderProps()

Properties for a SAML provider.

public SamlProviderProps()

Remarks

ExampleMetadata: infused

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

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

Remarks

ExampleMetadata: infused

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

Implements

ISamlProviderProps