Package software.amazon.awscdk.services.iam

Interface SamlProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SamlProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-27T16:50:58.710Z")
@Stability(Stable)
public interface SamlProviderProps
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	SamlProviderProps.Builder	A builder for SamlProviderProps
static final class	SamlProviderProps.Jsii$Proxy	An implementation for SamlProviderProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetadataDocument

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
static SamlProviderProps.Builder builder()

Returns:

a SamlProviderProps.Builder of SamlProviderProps