aws-cdk-lib.aws_iam.SamlMetadataDocument

class SamlMetadataDocument

LanguageType name
.NETAmazon.CDK.AWS.IAM.SamlMetadataDocument
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiam#SamlMetadataDocument
Javasoftware.amazon.awscdk.services.iam.SamlMetadataDocument
Pythonaws_cdk.aws_iam.SamlMetadataDocument
TypeScript (source)aws-cdk-lib » aws_iam » SamlMetadataDocument

A SAML metadata document.

Example

const provider = new iam.SamlProvider(this, 'Provider', {
  metadataDocument: iam.SamlMetadataDocument.fromFile('/path/to/saml-metadata-document.xml'),
});
const principal = new iam.SamlPrincipal(provider, {
  StringEquals: {
    'SAML:iss': 'issuer',
  },
});

Initializer

new SamlMetadataDocument()

Properties

NameTypeDescription
xmlstringThe XML content of the metadata document.

xml

Type: string

The XML content of the metadata document.

Methods

NameDescription
static fromFile(path)Create a SAML metadata document from a XML file.
static fromXml(xml)Create a SAML metadata document from a XML string.

static fromFile(path)

public static fromFile(path: string): SamlMetadataDocument

Parameters

  • path string

Returns

  • SamlMetadataDocument

Create a SAML metadata document from a XML file.


static fromXml(xml)

public static fromXml(xml: string): SamlMetadataDocument

Parameters

  • xml string

Returns

  • SamlMetadataDocument

Create a SAML metadata document from a XML string.