Package software.amazon.awscdk.services.iam

Class SamlMetadataDocument

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.iam.SamlMetadataDocument
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.371Z") @Stability(Stable) public abstract class SamlMetadataDocument extends software.amazon.jsii.JsiiObject
A SAML metadata document.

Example: 

 SamlProvider provider = SamlProvider.Builder.create(this, "Provider")
         .metadataDocument(SamlMetadataDocument.fromFile("/path/to/saml-metadata-document.xml"))
         .build();
 SamlPrincipal principal = new SamlPrincipal(provider, Map.of(
         "StringEquals", Map.of(
                 "SAML:iss", "issuer")));

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    SamlMetadataDocument()
     
    protected
    SamlMetadataDocument(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    SamlMetadataDocument(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static SamlMetadataDocument
    fromFile(String path)
    Create a SAML metadata document from a XML file.
    static SamlMetadataDocument
    fromXml(String xml)
    Create a SAML metadata document from a XML string.
    abstract String
    getXml()
    The XML content of the metadata document.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • SamlMetadataDocument

      protected SamlMetadataDocument(software.amazon.jsii.JsiiObjectRef objRef)

    • SamlMetadataDocument

      protected SamlMetadataDocument(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • SamlMetadataDocument

      @Stability(Stable) protected SamlMetadataDocument()

  • Method Details

    • fromFile

      @Stability(Stable) @NotNull public static SamlMetadataDocument fromFile(@NotNull String path)
      Create a SAML metadata document from a XML file.

      Parameters:
      path - This parameter is required.

    • fromXml

      @Stability(Stable) @NotNull public static SamlMetadataDocument fromXml(@NotNull String xml)
      Create a SAML metadata document from a XML string.

      Parameters:
      xml - This parameter is required.

    • getXml

      @Stability(Stable) @NotNull public abstract String getXml()
      The XML content of the metadata document.