software.amazon.awscdk.services.iam

Interface SamlProviderProps

All Known Implementing Classes:

SamlProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:46.910Z")
public interface SamlProviderProps

Properties for a SAML provider.

Example:

 SamlProvider provider = SamlProvider.Builder.create(this, "Provider")
         .metadataDocument(SamlMetadataDocument.fromFile("/path/to/saml-metadata-document.xml"))
         .build();
 Role.Builder.create(this, "Role")
         .assumedBy(new SamlConsolePrincipal(provider))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SamlProviderProps.Builder A builder for SamlProviderProps
static class	SamlProviderProps.Jsii$Proxy An implementation for SamlProviderProps

Method Summary

Modifier and Type	Method and Description
static SamlProviderProps.Builder	builder()
SamlMetadataDocument	getMetadataDocument() An XML document generated by an identity provider (IdP) that supports SAML 2.0.
default java.lang.String	getName() The name of the provider to create.

Method Detail

getMetadataDocument

SamlMetadataDocument getMetadataDocument()

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.

getName

default java.lang.String getName()

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

builder

static SamlProviderProps.Builder builder()

Returns:

a SamlProviderProps.Builder of SamlProviderProps