AWS CDK Reference

Appearance

v2.274.0

SamlProviderProps Struct ​

Properties for a SAML provider.

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

Example ​

ts
const provider = new iam.SamlProvider(this, 'Provider', {
  metadataDocument: iam.SamlMetadataDocument.fromFile('/path/to/saml-metadata-document.xml'),
});
new iam.Role(this, 'Role', {
  assumedBy: new iam.SamlConsolePrincipal(provider),
});

Properties ​

metadataDocumentSamlMetadataDocumentmetadata_documentSamlMetadataDocumentmetadataDocumentSamlMetadataDocumentMetadataDocumentSamlMetadataDocumentMetadataDocumentSamlMetadataDocumentrequired#
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.
namestringnamestrnameStringNamestringName*string= a CloudFormation generated name#
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.