UNPKG

2.11 kBTypeScriptView Raw
1import { IResource, Resource } from '@aws-cdk/core';
2import { Construct } from 'constructs';
3/**
4 * A SAML provider
5 */
6export interface ISamlProvider extends IResource {
7 /**
8 * The Amazon Resource Name (ARN) of the provider
9 *
10 * @attribute
11 */
12 readonly samlProviderArn: string;
13}
14/**
15 * Properties for a SAML provider
16 */
17export interface SamlProviderProps {
18 /**
19 * The name of the provider to create.
20 *
21 * This parameter allows a string of characters consisting of upper and
22 * lowercase alphanumeric characters with no spaces. You can also include
23 * any of the following characters: _+=,.@-
24 *
25 * Length must be between 1 and 128 characters.
26 *
27 * @default - a CloudFormation generated name
28 */
29 readonly name?: string;
30 /**
31 * An XML document generated by an identity provider (IdP) that supports
32 * SAML 2.0. The document includes the issuer's name, expiration information,
33 * and keys that can be used to validate the SAML authentication response
34 * (assertions) that are received from the IdP. You must generate the metadata
35 * document using the identity management software that is used as your
36 * organization's IdP.
37 */
38 readonly metadataDocument: SamlMetadataDocument;
39}
40/**
41 * A SAML metadata document
42 */
43export declare abstract class SamlMetadataDocument {
44 /**
45 * Create a SAML metadata document from a XML string
46 */
47 static fromXml(xml: string): SamlMetadataDocument;
48 /**
49 * Create a SAML metadata document from a XML file
50 */
51 static fromFile(path: string): SamlMetadataDocument;
52 /**
53 * The XML content of the metadata document
54 */
55 abstract readonly xml: string;
56}
57/**
58 * A SAML provider
59 */
60export declare class SamlProvider extends Resource implements ISamlProvider {
61 /**
62 * Import an existing provider
63 */
64 static fromSamlProviderArn(scope: Construct, id: string, samlProviderArn: string): ISamlProvider;
65 readonly samlProviderArn: string;
66 constructor(scope: Construct, id: string, props: SamlProviderProps);
67}