aws-cdk-lib/aws-iam/lib/saml-provider.d.ts

Version 2 of the AWS Cloud Development Kit library

import { Construct } from 'constructs';
import { IResource, Resource } from '../../core';
/**
 * A SAML provider
 */
export interface ISamlProvider extends IResource {
    /**
     * The Amazon Resource Name (ARN) of the provider
     *
     * @attribute
     */
    readonly samlProviderArn: string;
}
/**
 * Properties for a SAML provider
 */
export interface SamlProviderProps {
    /**
     * The name of the provider to create.
     *
     * 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
     */
    readonly name?: string;
    /**
     * 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.
     */
    readonly metadataDocument: SamlMetadataDocument;
}
/**
 * A SAML metadata document
 */
export declare abstract class SamlMetadataDocument {
    /**
     * Create a SAML metadata document from a XML string
     */
    static fromXml(xml: string): SamlMetadataDocument;
    /**
     * Create a SAML metadata document from a XML file
     */
    static fromFile(path: string): SamlMetadataDocument;
    /**
     * The XML content of the metadata document
     */
    abstract readonly xml: string;
}
/**
 * A SAML provider
 */
export declare class SamlProvider extends Resource implements ISamlProvider {
    /**
     * Import an existing provider
     */
    static fromSamlProviderArn(scope: Construct, id: string, samlProviderArn: string): ISamlProvider;
    readonly samlProviderArn: string;
    constructor(scope: Construct, id: string, props: SamlProviderProps);
}