AWS CDK Reference

Appearance

v2.273.0

SamlMetadataDocument Class ​

A SAML metadata document.

Source
aws-iam/lib/saml-provider.ts

Example ​

ts
vpc.addClientVpnEndpoint('Endpoint', {
  cidr: '10.100.0.0/16',
  serverCertificateArn: 'arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id',
  // Mutual authentication
  clientCertificateArn: 'arn:aws:acm:us-east-1:123456789012:certificate/client-certificate-id',
  // User-based authentication
  userBasedAuthentication: ec2.ClientVpnUserBasedAuthentication.federated(samlProvider),
});

Initializer ​

ts
new SamlMetadataDocument()
python
SamlMetadataDocument()
java
new SamlMetadataDocument()
csharp
new SamlMetadataDocument()
go
NewSamlMetadataDocument()

Properties ​

xmlstringxmlstrxmlStringXmlstringXml*stringrequired#
The XML content of the metadata document.

Methods ​

fromFile(path: string): SamlMetadataDocument // chainable@staticmethod def from_file(path: str) -> SamlMetadataDocumentpublic static SamlMetadataDocument fromFile(String path)public static SamlMetadataDocument FromFile(string path)func FromFile(Path *string) SamlMetadataDocumentstatic#
Create a SAML metadata document from a XML file.
fromXml(xml: string): SamlMetadataDocument // chainable@staticmethod def from_xml(xml: str) -> SamlMetadataDocumentpublic static SamlMetadataDocument fromXml(String xml)public static SamlMetadataDocument FromXml(string xml)func FromXml(Xml *string) SamlMetadataDocumentstatic#
Create a SAML metadata document from a XML string.