Skip to content
v2.278.0

SamlMetadataDocument Class ​

A SAML metadata document.

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),
});
python
vpc.add_client_vpn_endpoint("Endpoint",
    cidr="10.100.0.0/16",
    server_certificate_arn="arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id",
    # Mutual authentication
    client_certificate_arn="arn:aws:acm:us-east-1:123456789012:certificate/client-certificate-id",
    # User-based authentication
    user_based_authentication=ec2.ClientVpnUserBasedAuthentication.federated(saml_provider)
)
java
vpc.addClientVpnEndpoint("Endpoint", ClientVpnEndpointOptions.builder()
        .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(ClientVpnUserBasedAuthentication.federated(samlProvider))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
vpc.AddClientVpnEndpoint("Endpoint", new ClientVpnEndpointOptions {
    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 = ClientVpnUserBasedAuthentication.Federated(samlProvider)
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
vpc.addClientVpnEndpoint(jsii.String("Endpoint"), &ClientVpnEndpointOptions{
	Cidr: jsii.String("10.100.0.0/16"),
	ServerCertificateArn: jsii.String("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id"),
	// Mutual authentication
	ClientCertificateArn: jsii.String("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*string #
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) SamlMetadataDocument static #
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) SamlMetadataDocument static #
Create a SAML metadata document from a XML string.